about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorMazdak Farrokhzad <twingoow@gmail.com>2019-02-22 14:58:09 +0100
committerGitHub <noreply@github.com>2019-02-22 14:58:09 +0100
commitb28a32fba77f7c50497e15109773838fef07b0e7 (patch)
treea57c7acb37564fb3bbb14de9e3ef2443a10b9c59 /src
parent555df2bba18bfac212a335c059520d86ac0eb451 (diff)
parent102436d16a5e3d46fbd05afc7607e1a4b0209c8f (diff)
downloadrust-b28a32fba77f7c50497e15109773838fef07b0e7.tar.gz
rust-b28a32fba77f7c50497e15109773838fef07b0e7.zip
Rollup merge of #58606 - stjepang:put-future-into-spotlight, r=alexcrichton
Docs: put Future trait into spotlight

If a function returns a type that implements `Future`, there should be a small "i" symbol next to it indicating the return type implements an important trait.
Diffstat (limited to 'src')
-rw-r--r--src/libcore/future/future.rs1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/libcore/future/future.rs b/src/libcore/future/future.rs
index 84e7147153e..a143b54a61f 100644
--- a/src/libcore/future/future.rs
+++ b/src/libcore/future/future.rs
@@ -24,6 +24,7 @@ use task::{Poll, Waker};
 ///
 /// When using a future, you generally won't call `poll` directly, but instead
 /// `await!` the value.
+#[doc(spotlight)]
 #[must_use = "futures do nothing unless polled"]
 pub trait Future {
     /// The type of value produced on completion.