File tree 1 file changed +5
-2
lines changed
1 file changed +5
-2
lines changed Original file line number Diff line number Diff line change @@ -195,8 +195,10 @@ impl Condvar {
195
195
if poisoned { Err ( PoisonError :: new ( guard) ) } else { Ok ( guard) }
196
196
}
197
197
198
- /// Blocks the current thread until this condition variable receives a
199
- /// notification and the provided condition is false.
198
+ /// Blocks the current thread until the provided `condition` is met.
199
+ ///
200
+ /// While `condition` is not met, this function will [`wait`] for
201
+ /// notification, before again checking `condition`.
200
202
///
201
203
/// This function will atomically unlock the mutex specified (represented by
202
204
/// `guard`) and block the current thread. This means that any calls
@@ -210,6 +212,7 @@ impl Condvar {
210
212
/// poisoned when this thread re-acquires the lock. For more information,
211
213
/// see information about [poisoning] on the [`Mutex`] type.
212
214
///
215
+ /// [`wait`]: Self::wait
213
216
/// [`notify_one`]: Self::notify_one
214
217
/// [`notify_all`]: Self::notify_all
215
218
/// [poisoning]: super::Mutex#poisoning
You can’t perform that action at this time.
0 commit comments