Skip to content

Commit 2946f7a

Browse files
authored
improve wording of Waker::wake documentation
1 parent f52ebaa commit 2946f7a

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

library/core/src/task/wake.rs

+8-6
Original file line numberDiff line numberDiff line change
@@ -220,12 +220,14 @@ unsafe impl Sync for Waker {}
220220
impl Waker {
221221
/// Wake up the task associated with this `Waker`.
222222
///
223-
/// Multiple wake-ups (through clones of this `Waker` or `wake_by_ref`) may be
224-
/// coalesced into a single `poll` invocation by the runtime, and as long as
225-
/// the runtime keeps running and the task is not finished it is expected that
226-
/// each wake-up is followed by an invocation of `poll`, even in the absence of
227-
/// other events. This makes it possible to yield to other tasks when running
228-
/// potentially unbounded processing loops in order to maintain fairness.
223+
/// As long as the runtime keeps running and the task is not finished, it is
224+
/// guaranteed that each invocation of `wake` (or `wake_by_ref`) will be followed
225+
/// by at least one `poll` of the task to which this `Waker` belongs. This makes
226+
/// it possible to temporarily yield to other tasks while running potentially
227+
/// unbounded processing loops.
228+
///
229+
/// Note that the above implies that multiple wake-ups may be coalesced into a
230+
/// single `poll` invocation by the runtime.
229231
#[inline]
230232
#[stable(feature = "futures_api", since = "1.36.0")]
231233
pub fn wake(self) {

0 commit comments

Comments
 (0)