Rollup merge of #122916 - MultisampledNight:docs-sync-typo, r=jhpratt
docs(sync): normalize dot in fn summaries All other functions in e.g. [`Mutex`](https://doc.rust-lang.org/std/sync/struct.Mutex.html) have a dot at the end of their first doc line, except for the newly stabilized [`Mutex::clear_poison`](https://doc.rust-lang.org/std/sync/struct.Mutex.html#method.clear_poison) (and its friend [`RwLock::clear_poison`](https://doc.rust-lang.org/std/sync/struct.RwLock.html#method.clear_poison)). This PR remedies that by adding a normalizing dot.
This commit is contained in:
commit
eee0cd11a4
@ -396,7 +396,7 @@ impl<T: ?Sized> Mutex<T> {
|
||||
self.poison.get()
|
||||
}
|
||||
|
||||
/// 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. This
|
||||
/// allows recovering from a poisoned state and marking that it has recovered. For example, if
|
||||
|
@ -439,7 +439,7 @@ impl<T: ?Sized> RwLock<T> {
|
||||
self.poison.get()
|
||||
}
|
||||
|
||||
/// 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. This allows
|
||||
/// recovering from a poisoned state and marking that it has recovered. For example, if the
|
||||
|
Loading…
x
Reference in New Issue
Block a user