about summary refs log tree commit diff
diff options
context:
space:
mode:
authorYuki Okushi <huyuumi.dev@gmail.com>2020-12-19 15:16:01 +0900
committerGitHub <noreply@github.com>2020-12-19 15:16:01 +0900
commit60aad47c1369e72e0ac4f297b710d2a19d2d202b (patch)
tree1baeb0fd8b8ebcae708ae46664c9f40a81335b66
parent0765536c0be31100eaa4bf6d00274bbad280621c (diff)
parent48d5874914083e920a8500e860d01d1757701283 (diff)
Rollup merge of #79211 - yoshuawuyts:future-doc-alias, r=Mark-Simulacrum
Add the "async" and "promise" doc aliases to `core::future::Future`

Adds the "async" and "promise" doc aliases to `core::future::Future`. This enables people who search for "async" or "promise" to find `Future`, which is Rust's core primitive for async programming. Thanks!
-rw-r--r--library/std/src/keyword_docs.rs1
1 files changed, 1 insertions, 0 deletions
diff --git a/library/std/src/keyword_docs.rs b/library/std/src/keyword_docs.rs
index 8174cf5c373..417a54e9dff 100644
--- a/library/std/src/keyword_docs.rs
+++ b/library/std/src/keyword_docs.rs
@@ -2196,6 +2196,7 @@ mod where_keyword {}
 
 // 2018 Edition keywords
 
+#[doc(alias = "promise")]
 #[doc(keyword = "async")]
 //
 /// Return a [`Future`] instead of blocking the current thread.