Skip to content

Clarify doc for Error::description #37163

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
bluss opened this issue Oct 14, 2016 · 0 comments
Closed

Clarify doc for Error::description #37163

bluss opened this issue Oct 14, 2016 · 0 comments

Comments

@bluss
Copy link
Member

bluss commented Oct 14, 2016

The doc should advise those implementing Error that description is for a simple message (typically a literal), and Display is used for formatted error messages with more info.
@bluss bluss added the A-docs label Oct 14, 2016
@omern1 omern1 mentioned this issue Oct 15, 2016
Merged
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Oct 17, 2016
@GuillaumeGomez
Rollup merge of rust-lang#37189 - nabeelomer:master, r=bluss
28416cb 
Updated the docs for Error::description

Fixes rust-lang#37163
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
@bluss