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.

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

Crate-level documentation and README should mention that it is about error handling #62

Closed
vi opened this issue Apr 25, 2019 · 2 comments · Fixed by #66
Closed

Crate-level documentation and README should mention that it is about error handling #62

vi opened this issue Apr 25, 2019 · 2 comments · Fixed by #66
Labels
maintenance Keeping the wheels turning

Comments

@vi
Copy link

vi commented Apr 25, 2019

Easily assign underlying errors into domain-specific errors while adding context

This phrase is only in Github repository description. It is not obvious what is this library about from looking at README or crate-level doc.

Something like the phrase from Github repository description should be copied to the opt of the doc.

@shepmaster shepmaster added the maintenance Keeping the wheels turning label Apr 25, 2019
@shepmaster
Copy link
Owner

Keeping those three things in sync is always a pain, thanks for helping me to remember!

that it is about error handling

So, this is a bit odd, but I've wondered if this crate really is about error handling. We don't really handle the error, just enhance it to provide more information. Handling an error would be a match or Result::or_else, etc.

Since I have you here... do you have any ideas for what this would be properly called?

@vi
Copy link
Author

vi commented Apr 26, 2019

I assumed "error handling" == "error management" (in library context); crates like quick-error, error-chain, failure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Keeping the wheels turning
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants