squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Rollup merge of #58606 - stjepang:put-future-into-spotlight, r=alexcrichton

Browse source 
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.
This commit is contained in:
Mazdak Farrokhzad 2019-02-22 14:58:09 +01:00 committed by GitHub
commit b28a32fba7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/libcore/future/future.rs
View file

@ -24,6 +24,7 @@ use task::{Poll, Waker};
/// ///
/// When using a future, you generally won't call `poll` directly, but instead /// When using a future, you generally won't call `poll` directly, but instead
/// `await!` the value. /// `await!` the value.
#[doc(spotlight)]
#[must_use = "futures do nothing unless polled"] #[must_use = "futures do nothing unless polled"]
pub trait Future { pub trait Future {
/// The type of value produced on completion. /// The type of value produced on completion.