Skip to content

Spellfix for Debug trait #21586

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
merged 1 commit into from
Jan 27, 2015
Merged

Spellfix for Debug trait #21586

merged 1 commit into from
Jan 27, 2015

Conversation

pyfisch
Copy link
Contributor

@pyfisch pyfisch commented Jan 24, 2015

Spellfix for Debug trait documentation. Change "most all types should implement this" to "all types should implement this". Same fix for deprecated Show trait.

Spellfix for `Debug` trait documentation. Change "most all types should implement this" to "all types should implement this". Same fix for deprecated `Show` trait.
@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 @brson (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. 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 CONTRIBUTING.md for more information.

@alexcrichton
Copy link
Member

@bors: r+ 0736ad3 rollup

@alexcrichton alexcrichton assigned alexcrichton and unassigned brson Jan 24, 2015
@ftxqxd
Copy link
Contributor

ftxqxd commented Jan 24, 2015

Hmm, when I read this, I thought it was intentional, with ‘most all’ informally meaning ‘almost all’. I think that this should probably be changed to ‘almost all’ instead of just ‘all’, unless we are recommending that literally every type should implement Show?

@pyfisch
Copy link
Contributor Author

pyfisch commented Jan 24, 2015

Thanks for your comment. I assumed that the "most" was a forgotten word. English language is quite interesting, but I would prefer if the docs would use a form I understand. :grin

I found a RFC that clarifies what types should implement Debug.

The fmt::Debug trait is intended for debugging. It should:

  • Be implemented on every type, usually via #[derive(Debug)].

Now it should be clear that "all" is correct, or isn't it?

By the way I think it would be a great thing if the important parts of the RFC would be part of the docs.

barosl added a commit to barosl/rust that referenced this pull request Jan 27, 2015
Spellfix for `Debug` trait documentation. Change "most all types should implement this" to "all types should implement this". Same fix for deprecated `Show` trait.
@bors
Copy link
Collaborator

bors commented Jan 27, 2015

⌛ Testing commit 0736ad3 with merge 7774359...

bors added a commit that referenced this pull request Jan 27, 2015
Spellfix for `Debug` trait documentation. Change "most all types should implement this" to "all types should implement this". Same fix for deprecated `Show` trait.
@bors bors merged commit 0736ad3 into rust-lang:master Jan 27, 2015
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