Add guidelines explaining what attachments (and contexts) should look like #1017
Labels
area/libs > error-stack
Affects the `error-stack` crate (library)
category/enhancement
New feature or request
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.
The text was updated successfully, but these errors were encountered: