diff options
| author | r00ster91 <r00ster91@protonmail.com> | 2022-02-19 17:17:40 +0100 |
|---|---|---|
| committer | r00ster91 <r00ster91@protonmail.com> | 2022-02-19 17:17:40 +0100 |
| commit | 297364eb07a3f3d1dfab35fc6187202293ecffe0 (patch) | |
| tree | fae968ec070eea726a420fcc848d9b5028a32a9d /library/std/src | |
| parent | 8a48b376d559f26a9b8fc1f1d597acb0bc0a51f9 (diff) | |
| download | rust-297364eb07a3f3d1dfab35fc6187202293ecffe0.tar.gz rust-297364eb07a3f3d1dfab35fc6187202293ecffe0.zip | |
Some improvements to the async docs
Diffstat (limited to 'library/std/src')
| -rw-r--r-- | library/std/src/keyword_docs.rs | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/library/std/src/keyword_docs.rs b/library/std/src/keyword_docs.rs index a370485102e..ed32e2f4f67 100644 --- a/library/std/src/keyword_docs.rs +++ b/library/std/src/keyword_docs.rs @@ -2203,17 +2203,18 @@ mod where_keyword {} /// /// Use `async` in front of `fn`, `closure`, or a `block` to turn the marked code into a `Future`. /// As such the code will not be run immediately, but will only be evaluated when the returned -/// future is `.await`ed. +/// future is [`.await`]ed. /// -/// We have written an [async book] detailing async/await and trade-offs compared to using threads. +/// We have written an [async book] detailing `async`/`await` and trade-offs compared to using threads. /// /// ## Editions /// /// `async` is a keyword from the 2018 edition onwards. /// -/// It is available for use in stable rust from version 1.39 onwards. +/// It is available for use in stable Rust from version 1.39 onwards. /// /// [`Future`]: future::Future +/// [`.await`]: ../std/keyword.await.html /// [async book]: https://rust-lang.github.io/async-book/ mod async_keyword {} @@ -2221,19 +2222,20 @@ mod async_keyword {} // /// Suspend execution until the result of a [`Future`] is ready. /// -/// `.await`ing a future will suspend the current function's execution until the `executor` +/// `.await`ing a future will suspend the current function's execution until the executor /// has run the future to completion. /// -/// Read the [async book] for details on how async/await and executors work. +/// Read the [async book] for details on how [`async`]/`await` and executors work. /// /// ## Editions /// /// `await` is a keyword from the 2018 edition onwards. /// -/// It is available for use in stable rust from version 1.39 onwards. +/// It is available for use in stable Rust from version 1.39 onwards. /// /// [`Future`]: future::Future /// [async book]: https://rust-lang.github.io/async-book/ +/// [`async`]: ../std/keyword.async.html mod await_keyword {} #[doc(keyword = "dyn")] |
