Skip to content

Commit ff1a2f6

Browse files
authored
Rollup merge of #97821 - Nilstrieb:mutex-docs, r=Dylan-DPC
Remove confusing sentence from `Mutex` docs The docs were saying something about "statically initializing" the mutex, and it's not clear what this means. Remove that part to avoid confusion.
2 parents c1b5d49 + e224185 commit ff1a2f6

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

library/std/src/sync/mutex.rs

+4-5
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@ use crate::sys_common::mutex as sys;
1010
/// A mutual exclusion primitive useful for protecting shared data
1111
///
1212
/// This mutex will block threads waiting for the lock to become available. The
13-
/// mutex can also be statically initialized or created via a [`new`]
14-
/// constructor. Each mutex has a type parameter which represents the data that
15-
/// it is protecting. The data can only be accessed through the RAII guards
16-
/// returned from [`lock`] and [`try_lock`], which guarantees that the data is only
17-
/// ever accessed when the mutex is locked.
13+
/// mutex can be created via a [`new`] constructor. Each mutex has a type parameter
14+
/// which represents the data that it is protecting. The data can only be accessed
15+
/// through the RAII guards returned from [`lock`] and [`try_lock`], which
16+
/// guarantees that the data is only ever accessed when the mutex is locked.
1817
///
1918
/// # Poisoning
2019
///

0 commit comments

Comments
 (0)