Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(docs): make mutex error comment consistent with codebase #77660

Merged
merged 1 commit into from
Oct 9, 2020

Conversation

nilslice
Copy link
Contributor

@nilslice nilslice commented Oct 7, 2020

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.

@rust-highfive
Copy link
Collaborator

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 rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 7, 2020
@jyn514
Copy link
Member

jyn514 commented Oct 8, 2020

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Oct 8, 2020

📌 Commit 56b51a9 has been approved by jyn514

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 8, 2020
@jyn514 jyn514 added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. labels Oct 8, 2020
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`
@bors bors merged commit 7edb7e7 into rust-lang:master Oct 9, 2020
@rustbot rustbot added this to the 1.49.0 milestone Oct 9, 2020
@nilslice nilslice deleted the patch-1 branch October 9, 2020 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants