Skip to content

Commit f14a115

Browse files
committed
link to Future::poll from the Poll docs
The most important thing about Poll is that Future::poll returns it, but previously the docs didn't emphasize this.
1 parent f167efa commit f14a115

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

library/core/src/task/poll.rs

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ use crate::ops::{self, ControlFlow};
55

66
/// Indicates whether a value is available or if the current task has been
77
/// scheduled to receive a wakeup instead.
8+
///
9+
/// This is the return type of <code>[Future::poll]</code>.
10+
///
11+
/// [Future::poll]: ../future/trait.Future.html "Future"
812
#[must_use = "this `Poll` may be a `Pending` variant, which should be handled"]
913
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
1014
#[lang = "Poll"]

0 commit comments

Comments
 (0)