Reduce duplication in error messages #532
Merged
Conversation
This file contains hidden or 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
This commit removes duplication in error messages where the same text would show up multiple times in a fully rendered error message. When using `derive(Error)` when the `#[from]` attribute is used there's no need to also render that payload into the error string because the `#[from]` establishes a "backtrace" which means that when the full context of an error is rendered it will include the `#[from]` in the lower frames of the backtrace anyway. This commit audits the `derive(Error)` implementations to avoid duplication in the rendered error messages, ensuring that if `#[from]` is used then the `#[from]` field isn't also rendered in the textual description.
sunfishcode
approved these changes
Nov 8, 2019
Don't just search the top error, but search the whole backtrace by using
the `{:?}` format instead of `{}`.
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This commit removes duplication in error messages where the same text
would show up multiple times in a fully rendered error message.
When using
derive(Error)when the#[from]attribute is used there'sno need to also render that payload into the error string because the
#[from]establishes a "backtrace" which means that when the fullcontext of an error is rendered it will include the
#[from]in thelower frames of the backtrace anyway.
This commit audits the
derive(Error)implementations to avoidduplication in the rendered error messages, ensuring that if
#[from]is used then the
#[from]field isn't also rendered in the textualdescription.