Skip to content

Updates the wording on error handling to improve clarity in CONTRIBUTING.md #336

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

Merged
merged 1 commit into from
Oct 17, 2017
Merged

Updates the wording on error handling to improve clarity in CONTRIBUTING.md #336

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,9 +147,10 @@ The example should have minimal code that doesn't directly support the
description of the example. Keep extra functions and types to a
minimum.

Follow the error handling templates in ["A note about error
handling"][errors]. Examples always set up error handling correctly and
propagate errors with `?` (not `try!`).
When an example must handle the possibility of errors, follow the error handling
templates in ["A note about error handling"][errors]. Examples always set up
error handling correctly and propagate errors with `?` (not `try!`). If there
is no need for error handling in the example, using `main()` is appropriate.

Don't use glob imports, even for preludes, so that users can see what
traits they are calling. (Some crates might consider using glob
Expand Down