(docs): make mutex error comment consistent with codebase #77660
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @kennytm (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
@bors r+ rollup |
|
📌 Commit 56b51a9 has been approved by |
bors
added
S-waiting-on-bors
jyn514
added
A-docs
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Oct 8, 2020
(docs): make mutex error comment consistent with codebase Although exceptionally minor, I found this stands out from other error reporting language used in doc comments. With the existence of the `failure` crate, I suppose this could be slightly ambiguous. In any case, this change brings the particular comment into a consistent state with other mentions of returning errors.
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 8, 2020
…as-schievink Rollup of 8 pull requests Successful merges: - rust-lang#76750 (Don't discourage implementing `core::fmt::Write`) - rust-lang#77449 (BTreeMap: comment why drain_filter's size_hint is somewhat pessimistic) - rust-lang#77660 ((docs): make mutex error comment consistent with codebase) - rust-lang#77663 (Add compile fail test for issue 27675) - rust-lang#77673 (Remove unnecessary lamda on emitter map.) - rust-lang#77701 (Make `max_log_info` easily greppable (for figuring out why debug logging is disabled)) - rust-lang#77702 (Remove not needed lambda.) - rust-lang#77710 (Update submodule llvm to get LVI bugfix) Failed merges: r? `@ghost`
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Although exceptionally minor, I found this stands out from other error reporting language used in doc comments. With the existence of the
failurecrate, I suppose this could be slightly ambiguous. In any case, this change brings the particular comment into a consistent state with other mentions of returning errors.