Add flake8-error-message
convention
#138
Merged
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.
Change Description
This feature implements the flake8-err-msg which allows the formatting of nice error messages.
Rationale
The problem is that Python includes the line with the lift in the default traceback. This means that a user receives a message like this:
If it is longer or more complex, the duplication can be confusing for a user not used to reading tracebacks.
On the other hand, if you always assign to something like msg, you get :
There is now a more straightforward trace, less code and no double messages.
Ref - Ruff linter
Testing/Review Recommendations
Inspection is enough
Future Work
#140