Skip to content

Commit b28a32f

Browse files
authored
Rollup merge of rust-lang#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.
2 parents 555df2b + 102436d commit b28a32f

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

src/libcore/future/future.rs

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

0 commit comments

Comments
 (0)