Improve consistency of error message wordings #722
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Base automatically changed from
edmorley/fix-libcnb-test-error-handling
to
main
November 7, 2023 12:52
* Use contractions per Simplified Technical English guidelines
(e.g. "Couldn't" instead of "Could not").
* Prefer using past tense for potentially transient failures
(e.g. "Couldn't read buildpack.toml" rather than "Can't").
* Prefer using actual filenames rather than their spec names
(e.g. "Couldn't read buildpack.toml" rather than
"Couldn't read buildpack descriptor").
* Use "I/O error" instead of "IO error" or "IOError"
* Use display representations when including underlying error
messages in the current error message where possible (ie: For
most errors apart from `io::Error`). This also means preferring
`panic!` over `.expect()`, since the latter uses the debug
representation instead of display.
* Use "Error ..." as the prefix for all top level error message
(i.e. at the `panic!` or `.expect()` call sites).
* Use `#[error(transparent)]` instead of `#[error("{0}")]` per:
#720 (comment)
GUS-W-14445374.
edmorley
force-pushed
the
edmorley/standardise-error-messages
branch
from
69f6026
to
d5129b0
Compare
Malax
approved these changes
Nov 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
io::Error). This also means preferringpanic!over.expect(), since the latter uses the debug representation instead of display.panic!or.expect()call sites).#[error(transparent)]instead of#[error("{0}")]per: Fix error messages for buildpack packaging failures #720 (comment)GUS-W-14445374.