Skip to content

Commit

Permalink
Rollup merge of rust-lang#58606 - stjepang:put-future-into-spotlight,…
Browse files Browse the repository at this point in the history
… 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.
  • Loading branch information
Centril authored Feb 22, 2019
2 parents 555df2b + 102436d commit b28a32f
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/libcore/future/future.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit b28a32f

Please sign in to comment.