Skip to content

book: Change "Failures" to "Errors" in doc special sections chapter #31345

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

Merged

Conversation

kamalmarhubi
Copy link
Contributor

This matches the usage in the standard library's documentation.

This matches the usage in the standard library's documentation.
@rust-highfive
Copy link
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (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.

@steveklabnik
Copy link
Member

Hmmm, I would like to hear what @rust-lang/libs has to say about this. "Failures" is the term we agreed upon when we changed fail! to panic!, so I'm inclined to believe that the standard library is wrong.

However, we may want to change that convention to Errors, as well, it's about Result::Err<E>.

@kamalmarhubi
Copy link
Contributor Author

Eep, I certainly wasn't expecting to be reporting a doc bug for the entire stdlib!

@aturon
Copy link
Member

aturon commented Feb 1, 2016

I think the book should be consistent with std's docs, which do indeed seem to use Errors (at least looking at IO). And the fact that it hooks into std::error terminology as well is a nice plus.

@brson
Copy link
Contributor

brson commented Feb 2, 2016

I think Errors is clearer.

@steveklabnik
Copy link
Member

Great, let's do it!

@kamalmarhubi would you like to also double-check std for any headings that say this and change them as well? If not, we can go ahead and merge this and I can do that separately.

@kamalmarhubi
Copy link
Contributor Author

@steveklabnik:

$ git grep '# Failures'
src/doc/book/documentation.md:/// # Failures

:-)

@kamalmarhubi
Copy link
Contributor Author

And just in case:

$ git grep '#.*Failures'
src/doc/book/documentation.md:/// # Failures

@steveklabnik
Copy link
Member

What about just "failure" without the s?

On Feb 1, 2016, 21:23 -0500, Kamal Marhubinotifications@github.com, wrote:

And just in case:

$ git grep '#.*Failures' src/doc/book/documentation.md:/// # Failures


Reply to this email directly orview it on GitHub(#31345 (comment)).

@kamalmarhubi
Copy link
Contributor Author

Urg, a bunch in std::sync. On it!

@kamalmarhubi
Copy link
Contributor Author

There you go!

@steveklabnik
Copy link
Member

@bors: r+ rollup

thanks so much!

@bors
Copy link
Collaborator

bors commented Feb 2, 2016

📌 Commit 129a623 has been approved by steveklabnik

steveklabnik added a commit to steveklabnik/rust that referenced this pull request Feb 2, 2016
…ion-errors, r=steveklabnik

This matches the usage in the standard library's documentation.
bors added a commit that referenced this pull request Feb 2, 2016
@bors bors merged commit 129a623 into rust-lang:master Feb 2, 2016
@kamalmarhubi kamalmarhubi deleted the book-docs-special-section-errors branch February 3, 2016 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants