diff options
| author | binarycat <binarycat@envs.net> | 2024-11-10 13:22:58 -0600 |
|---|---|---|
| committer | binarycat <binarycat@envs.net> | 2024-11-10 13:22:58 -0600 |
| commit | ae3c68db344f26d79c0a133a1a46c7929b1ea9ad (patch) | |
| tree | e4773a588669acdbd9a7fad0e48c3c603e27859e /library/alloc/src/task.rs | |
| parent | 7028d9318fadc20e5e3058d52e44d785d31a6aaa (diff) | |
| download | rust-ae3c68db344f26d79c0a133a1a46c7929b1ea9ad.tar.gz rust-ae3c68db344f26d79c0a133a1a46c7929b1ea9ad.zip | |
split up the first paragraph of doc comments for better summaries
Diffstat (limited to 'library/alloc/src/task.rs')
| -rw-r--r-- | library/alloc/src/task.rs | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/library/alloc/src/task.rs b/library/alloc/src/task.rs index 27589aed2f9..0f8e74300a4 100644 --- a/library/alloc/src/task.rs +++ b/library/alloc/src/task.rs @@ -176,9 +176,11 @@ fn raw_waker<W: Wake + Send + Sync + 'static>(waker: Arc<W>) -> RawWaker { ) } -/// An analogous trait to `Wake` but used to construct a `LocalWaker`. This API -/// works in exactly the same way as `Wake`, except that it uses an `Rc` instead -/// of an `Arc`, and the result is a `LocalWaker` instead of a `Waker`. +/// An analogous trait to `Wake` but used to construct a `LocalWaker`. +/// +/// This API works in exactly the same way as `Wake`, +/// except that it uses an `Rc` instead of an `Arc`, +/// and the result is a `LocalWaker` instead of a `Waker`. /// /// The benefits of using `LocalWaker` over `Waker` are that it allows the local waker /// to hold data that does not implement `Send` and `Sync`. Additionally, it saves calls |
