nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-04-28 11:07:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #122916 - MultisampledNight:docs-sync-typo, r=jhpratt

Browse Source 
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:
Matthias Krüger 2024-03-23 15:00:19 +01:00 committed by GitHub
commit eee0cd11a4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -396,7 +396,7 @@ impl<T: ?Sized> Mutex<T> {
self.poison.get() 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 /// 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 /// allows recovering from a poisoned state and marking that it has recovered. For example, if

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

@ -439,7 +439,7 @@ impl<T: ?Sized> RwLock<T> {
self.poison.get() 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 /// 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 /// recovering from a poisoned state and marking that it has recovered. For example, if the