Adjust doc comment of Condvar::wait_while · patricklam/verify-rust-std@fd0bc94 (original) (raw)

`@@ -195,8 +195,11 @@ 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 becomes false.

`

``

199

`+

///

`

``

200

`` +

/// condition is checked immediately; if not met (returns true), this

``

``

201

`` +

/// will [wait] for the next notification then check again. This repeats

``

``

202

`` +

/// until condition returns false, in which case this function returns.

``

200

203

`///

`

201

204

`/// This function will atomically unlock the mutex specified (represented by

`

202

205

`` /// guard) and block the current thread. This means that any calls

``

`@@ -210,6 +213,7 @@ impl Condvar {

`

210

213

`/// poisoned when this thread re-acquires the lock. For more information,

`

211

214

`` /// see information about [poisoning] on the [Mutex] type.

``

212

215

`///

`

``

216

`` +

/// [wait]: Self::wait

``

213

217

`` /// [notify_one]: Self::notify_one

``

214

218

`` /// [notify_all]: Self::notify_all

``

215

219

`/// [poisoning]: super::Mutex#poisoning

`