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.

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

Document error conditions in "Errors" sections #78

Closed
dtolnay opened this issue Apr 4, 2017 · 1 comment
Closed

Document error conditions in "Errors" sections #78

dtolnay opened this issue Apr 4, 2017 · 1 comment
Labels
easy help wanted

Comments

@dtolnay
Copy link
Member

dtolnay commented Apr 4, 2017

Per RFC 1574, error conditions should be documented in an "Errors" section.

selection_032

Good example of an "Errors" section from the standard library documentation: std::io::Read::read
@dtolnay dtolnay mentioned this issue Apr 4, 2017
Closed
15 tasks
@dtolnay
Copy link
Member Author

dtolnay commented Apr 4, 2017

This affects every method that returns Result, not just the one in the screenshot.

@opilar opilar mentioned this issue Apr 19, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
easy help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@brson @dtolnay