Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upInconsistency in the document of std::sync::Mutex #40176
Comments
steveklabnik
added
the
A-docs
label
Mar 1, 2017
steveklabnik
added
T-doc
and removed
T-doc
labels
Mar 10, 2017
This comment has been minimized.
This comment has been minimized.
|
docs team triage: @GuillaumeGomez is gonna take this one |
steveklabnik
added
the
P-high
label
Mar 15, 2017
steveklabnik
assigned
GuillaumeGomez
Mar 15, 2017
steveklabnik
removed
the
A-docs
label
Mar 24, 2017
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Apr 3, 2017
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Apr 3, 2017
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Apr 4, 2017
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Apr 4, 2017
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Apr 4, 2017
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Apr 5, 2017
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Apr 5, 2017
bors
closed this
in
#40608
Apr 5, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
topecongiro commentedMar 1, 2017
In the document of std::sync::Mutex, lock and mutex are used interchangeably.
For example, the document of
lock()is as follows:Here, the lock and the mutex are used to refer to the same
Mutexobject. As a non-native English speaker, this kind of inconsistency is somewhat confusing. This is especially the case for this document because lock also refers to the operation on the mutex object.I do understand these two words are interchangable unless you are writing a thesis or the like. However, I feel that using them consistently throughout the document makes it more readable.
Therefore, I would like to suggest to use mutex to refer to the
Mutexobject, and lock or unlock to refer to the operations on theMutexobject.e.g. An RAII guard is returned to allow scoped unlock of the mutex.
Sorry in advance if this inconsistency is intentional.