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.
This commit is contained in:
Jack O'Connor 2024-08-24 18:14:52 -07:00
parent 89103466d7
commit 3153b7d7b4
1 changed files with 2 additions and 0 deletions

View File

@ -5,6 +5,8 @@ use crate::ops::{self, ControlFlow};
/// Indicates whether a value is available or if the current task has been
/// scheduled to receive a wakeup instead.
///
/// This is returned by [`Future::poll`](core::future::Future::poll).
#[must_use = "this `Poll` may be a `Pending` variant, which should be handled"]
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[lang = "Poll"]