From f14a1157bc14f2e83cc94a18ef0dca471e748ee7 Mon Sep 17 00:00:00 2001 From: Jack O'Connor Date: Sat, 24 Aug 2024 18:14:52 -0700 Subject: [PATCH] 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. --- library/core/src/task/poll.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/library/core/src/task/poll.rs b/library/core/src/task/poll.rs index bfa1cf096e237..bdc2107e85328 100644 --- a/library/core/src/task/poll.rs +++ b/library/core/src/task/poll.rs @@ -5,6 +5,10 @@ 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 the return type of [Future::poll]. +/// +/// [Future::poll]: ../future/trait.Future.html "Future" #[must_use = "this `Poll` may be a `Pending` variant, which should be handled"] #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)] #[lang = "Poll"]