mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove references to guards in documentation for clear_poison

Browse Source
This commit is contained in:
Thayne McCombs 2022-05-20 00:15:26 -06:00
parent 66d88c9a18
commit a65afd82d1
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
library/std/src/sync/mutex.rs
View File

@ -365,11 +365,11 @@ impl<T: ?Sized> Mutex<T> {
/// Clear the poisoned state from a mutex /// Clear the poisoned state from a mutex
/// ///
/// If the mutex is poisoned, it will remain poisoned until this function is called /// If the mutex is poisoned, it will remain poisoned until this function is called. This
/// with a mutex guard. This allows recovering from a poisoned state and marking /// allows recovering from a poisoned state and marking that it has recovered. For example, if
/// that it has recovered. For example, if the value is overwritten by a known-good value, /// the value is overwritten by a known-good value, then the mutex can be marked as
/// then the mutex can be marked as un-poisoned. Or possibly, the value could be inspected to /// un-poisoned. Or possibly, the value could be inspected to determine if it is in a
/// determine if it is in a consistent state, and if so the poison is removed. /// consistent state, and if so the poison is removed.
/// ///
/// # Examples /// # Examples
/// ///

10
library/std/src/sync/rwlock.rs
View File

@ -368,11 +368,11 @@ impl<T: ?Sized> RwLock<T> {
/// Clear the poisoned state from a lock /// Clear the poisoned state from a lock
/// ///
/// If the lock is poisoned, it will remain poisoned until this function is called /// If the lock is poisoned, it will remain poisoned until this function is called. This allows
/// with a write guard. This allows recovering from a poisoned state and marking /// recovering from a poisoned state and marking that it has recovered. For example, if the
/// that it has recovered. For example, if the value is overwritten by a known-good value, /// value is overwritten by a known-good value, then the mutex can be marked as un-poisoned. Or
/// then the mutex can be marked as un-poisoned. Or possibly, the value could be inspected to /// possibly, the value could be inspected to determine if it is in a consistent state, and if
/// determine if it is in a consistent state, and if so the poison is removed. /// so the poison is removed.
/// ///
/// # Examples /// # Examples
/// ///