Skip to content

Commit 22ec897

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 8dafd33 commit 22ec897

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

core/src/task/poll.rs

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ 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 returned by [`Future::poll`](core::future::Future::poll).
810
#[must_use = "this `Poll` may be a `Pending` variant, which should be handled"]
911
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
1012
#[lang = "Poll"]

0 commit comments

Comments
 (0)