Skip to content

Commit eee0cd1

Browse files
authored
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.
2 parents f03326c + e853b50 commit eee0cd1

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

library/std/src/sync/mutex.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ impl<T: ?Sized> Mutex<T> {
396396
self.poison.get()
397397
}
398398

399-
/// Clear the poisoned state from a mutex
399+
/// Clear the poisoned state from a mutex.
400400
///
401401
/// If the mutex is poisoned, it will remain poisoned until this function is called. This
402402
/// allows recovering from a poisoned state and marking that it has recovered. For example, if

library/std/src/sync/rwlock.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ impl<T: ?Sized> RwLock<T> {
439439
self.poison.get()
440440
}
441441

442-
/// Clear the poisoned state from a lock
442+
/// Clear the poisoned state from a lock.
443443
///
444444
/// If the lock is poisoned, it will remain poisoned until this function is called. This allows
445445
/// recovering from a poisoned state and marking that it has recovered. For example, if the

0 commit comments

Comments
 (0)