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

fix nit-picky doc typo #185

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix nit-picky doc typo #185

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4100f52
fix nit-picky doc typo
prasannavl Oct 9, 2019
b5c517e
docs: simplify philosophy wordings
prasannavl Oct 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/guide/philosophy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ effectively use SNAFU.

## Categorize underlying errors by their context

It should be easy to bin one underlying error type (such as
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't actually a typo. I'm using "bin" as a verb to mean "put into a box" / "sort" / "categorize". Can you think of a less confusing way of stating the same concept?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yikes, my bad. What do you think about wrap instead of either of them?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or map, may be?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you feel about "compartmentalize" or "classify"? I asked around at a meetup I'm at and those were suggested. We discussed "wrap" and "map", but weren't excited about "wrap" because it doesn't give the same sense of assigning one thing to multiple possible categories. "map" has some existing meaning in Rust-world with all the methods named map.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. PR updated.

It should be easy to classify one underlying error type (such as
[`io::Error`][Error]) into multiple domain-specific errors while
optionally adding contextual information.

Expand Down