Clarify error message styling #250
CobaltCause
started this conversation in
API Guidelines
Replies: 2 comments 2 replies
-
Might be worth coordinating the discussion with the knowledge from the error handling working group (see for example rust-lang/project-error-handling#27). |
Beta Was this translation helpful? Give feedback.
1 reply
-
Note that this is currently codified in stdlib docs: https://doc.rust-lang.org/stable/std/error/trait.Error.html
|
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
In this section, it's hinted that error messages should not assume they are the beginning of the sentence/message/log line/whatever and always start with a lowercase letter (unless the first word happens to be an initialism/acronym). I think it would be a good idea to codify this in a paragraph explaining why they're written this way which would explicitly make this a requirement to be considered to be following the guidelines.
Beta Was this translation helpful? Give feedback.
All reactions