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

Add guidelines explaining what attachments (and contexts) should look like #1017

Closed
TimDiekmann opened this issue Sep 1, 2022 · 0 comments · Fixed by #1122
Closed

Add guidelines explaining what attachments (and contexts) should look like #1017

TimDiekmann opened this issue Sep 1, 2022 · 0 comments · Fixed by #1122
Assignees
Labels
area/libs > error-stack Affects the `error-stack` crate (library) category/enhancement New feature or request

Comments

@TimDiekmann
Copy link
Member

Is your feature request related to a problem? Please describe.

We should add a section in the crate-level documentation on how to write attachments and context messages.

Describe the solution you'd like

We probably want to suggest using non-capitalized messages, this aligns well with the Rust API guidelines.

Describe alternatives you've considered

Capitalizing attachments may be more readable, however, it's a common practice to put errors in context and errors should not be capitalized. This results in inconsistency.

@TimDiekmann TimDiekmann added C-enhancement area/libs > error-stack Affects the `error-stack` crate (library) labels Sep 1, 2022
@vilkinsons vilkinsons changed the title Add short guideline how attachments (and contexts) should look like Add guidelines explaining what attachments (and contexts) should look like Sep 23, 2022
@vilkinsons vilkinsons added category/enhancement New feature or request and removed C-enhancement labels Jul 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/libs > error-stack Affects the `error-stack` crate (library) category/enhancement New feature or request
Development

Successfully merging a pull request may close this issue.

3 participants