Skip to content

Commit 0fb0680

Browse files
committed
Adjust doc comment of Condvar::wait_while
The existing phrasing implies that a notification must be received for `wait_while` to return. The phrasing is changed to better reflect the behavior.
1 parent d678b81 commit 0fb0680

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

library/std/src/sync/condvar.rs

+7-2
Original file line numberDiff line numberDiff line change
@@ -195,8 +195,12 @@ impl Condvar {
195195
if poisoned { Err(PoisonError::new(guard)) } else { Ok(guard) }
196196
}
197197

198-
/// Blocks the current thread until this condition variable receives a
199-
/// notification and the provided condition is false.
198+
/// Blocks the current thread while the provided condition stops returning
199+
/// `true`
200+
///
201+
/// `condition` is checked immediately; if not met (returns `true`), this
202+
/// will [`wait`] for the next notification then check again. This repeats
203+
/// until `condition` returns `false`, in which case this function returns.
200204
///
201205
/// This function will atomically unlock the mutex specified (represented by
202206
/// `guard`) and block the current thread. This means that any calls
@@ -210,6 +214,7 @@ impl Condvar {
210214
/// poisoned when this thread re-acquires the lock. For more information,
211215
/// see information about [poisoning] on the [`Mutex`] type.
212216
///
217+
/// [`wait`]: Self::wait
213218
/// [`notify_one`]: Self::notify_one
214219
/// [`notify_all`]: Self::notify_all
215220
/// [poisoning]: super::Mutex#poisoning

0 commit comments

Comments
 (0)