diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2024-03-23 15:00:19 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-23 15:00:19 +0100 |
| commit | eee0cd11a4ff7841bcc4eeacfbdea4239abab6a9 (patch) | |
| tree | 7d03061a74c53cf949d95b5c44a01a8312bed9dc | |
| parent | f03326c579e86b3554e1387f7530e1f2fab864cc (diff) | |
| parent | e853b50a722c09c7526683316b5471528063cccd (diff) | |
| download | rust-eee0cd11a4ff7841bcc4eeacfbdea4239abab6a9.tar.gz rust-eee0cd11a4ff7841bcc4eeacfbdea4239abab6a9.zip | |
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.
| -rw-r--r-- | library/std/src/sync/mutex.rs | 2 | ||||
| -rw-r--r-- | library/std/src/sync/rwlock.rs | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/library/std/src/sync/mutex.rs b/library/std/src/sync/mutex.rs index 895fcbd6b7e..d417034f5af 100644 --- a/library/std/src/sync/mutex.rs +++ b/library/std/src/sync/mutex.rs @@ -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 diff --git a/library/std/src/sync/rwlock.rs b/library/std/src/sync/rwlock.rs index f7f098c082a..d648cd08994 100644 --- a/library/std/src/sync/rwlock.rs +++ b/library/std/src/sync/rwlock.rs @@ -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 |
