Skip to content

fmt traits docs should provide more context #25765

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.

Sign up for GitHub

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

Jump to bottom
Closed
huonw opened this issue May 25, 2015 · 0 comments
Closed

fmt traits docs should provide more context #25765

huonw opened this issue May 25, 2015 · 0 comments

Comments

@huonw
Copy link
Member

huonw commented May 25, 2015

Someone looking at some code with, say, #[derive(Debug)] might search the docs for Debug and land on Debug, which doesn't make it immediately obvious what it is for (it currently just says "Format trait for the :? format. Useful for debugging, all types should implement this."). It would be great if each trait had an example of using it to format something and maybe an explicit pointer to the main std::fmt docs.
@huonw huonw added the A-docs label May 25, 2015
@steveklabnik steveklabnik mentioned this issue Jul 6, 2015
Merged
steveklabnik added a commit to steveklabnik/rust that referenced this issue Jul 6, 2015
@steveklabnik
Significantly improve formatter trait docs
3a6cd64 
Each formatting trait now has an example of implementation, as well as a
fuller description of what it's supposed to output.

It also contains a link to the module-level documentation which

Fixes rust-lang#25765
steveklabnik added a commit to steveklabnik/rust that referenced this issue Jul 6, 2015
@steveklabnik
Rollup merge of rust-lang#26828 - steveklabnik:gh25765, r=bluss
b170970 
Each formatting trait now has an example of implementation, as well as a
fuller description of what it's supposed to output.

It also contains a link to the module-level documentation which

Fixes rust-lang#25765
steveklabnik added a commit to steveklabnik/rust that referenced this issue Jul 6, 2015
@steveklabnik
Rollup merge of rust-lang#26828 - steveklabnik:gh25765, r=bluss
57e0e19 
Each formatting trait now has an example of implementation, as well as a
fuller description of what it's supposed to output.

It also contains a link to the module-level documentation which

Fixes rust-lang#25765
steveklabnik added a commit to steveklabnik/rust that referenced this issue Jul 7, 2015
@steveklabnik
Rollup merge of rust-lang#26828 - steveklabnik:gh25765, r=bluss
3e62e20 
Each formatting trait now has an example of implementation, as well as a
fuller description of what it's supposed to output.

It also contains a link to the module-level documentation which

Fixes rust-lang#25765
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@huonw