diff options
| author | Yuki Okushi <huyuumi.dev@gmail.com> | 2019-12-30 14:07:49 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-30 14:07:49 +0900 |
| commit | 0eb19dcf8beef2010eb4f4a63be0de7871d2db84 (patch) | |
| tree | 7d14e0cde9540ec78d70c9d87b62971fad5ba973 | |
| parent | 97a7b032988e047aebe1def53b0afc7c5f7356a6 (diff) | |
| parent | bc1b2d5017fd99ac0814167473d00e236a5ebbac (diff) | |
| download | rust-0eb19dcf8beef2010eb4f4a63be0de7871d2db84.tar.gz rust-0eb19dcf8beef2010eb4f4a63be0de7871d2db84.zip | |
Rollup merge of #67622 - gilescope:async-keyword-doc, r=Centril
Some keyword documentation. I thought about going into detail, but I'd much rather route them to the async book asap.
| -rw-r--r-- | src/libstd/keyword_docs.rs | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/src/libstd/keyword_docs.rs b/src/libstd/keyword_docs.rs index 7901c8197b5..5c7ee9bded9 100644 --- a/src/libstd/keyword_docs.rs +++ b/src/libstd/keyword_docs.rs @@ -1149,20 +1149,39 @@ mod where_keyword {} // /// Return a [`Future`] instead of blocking the current thread. /// -/// The documentation for this keyword is [not yet complete]. Pull requests welcome! +/// 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. +/// +/// 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. /// /// [`Future`]: ./future/trait.Future.html -/// [not yet complete]: https://github.com/rust-lang/rust/issues/34601 +/// [async book]: https://rust-lang.github.io/async-book/ mod async_keyword {} #[doc(keyword = "await")] // /// Suspend execution until the result of a [`Future`] is ready. /// -/// The documentation for this keyword is [not yet complete]. Pull requests welcome! +/// `.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. +/// +/// ## Editions +/// +/// `await` is a keyword from the 2018 edition onwards. +/// +/// It is available for use in stable rust from version 1.39 onwards. /// /// [`Future`]: ./future/trait.Future.html -/// [not yet complete]: https://github.com/rust-lang/rust/issues/34601 +/// [async book]: https://rust-lang.github.io/async-book/ mod await_keyword {} #[doc(keyword = "dyn")] |