[docs] Add docs for flake8-errmsg
#2888
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
| @@ -7,6 +7,51 @@ use crate::registry::{Diagnostic, Rule}; | |||
| use crate::violation::Violation; | |||
|
|
|||
| define_violation!( | |||
| /// ## What it does | |||
| /// Checks for raw usage of a string literal in Exception raising. | |||
There was a problem hiding this comment.
I know that the rule is currently named RawStringInException but I think it should be renamed from raw to direct since raw string usually refers to strings such as r"this".
So "raw usage" should be reworded here. Perhaps:
Checks for the direct supplying of a string literal to an exception constructor.
| /// RuntimeError: 'Some value' is incorrect | ||
| /// ``` | ||
| /// | ||
| /// Now there's a simpler traceback, less code, and no double message. If you have |
There was a problem hiding this comment.
less code is a bit ambiguous here ... your source code actually got more
|
This is again a case where I think it would make sense to merge all of these rules into one (see also #2714). They all check for the same problem ... I don't think there is any scenario where a user may want to enable one of these but not the others. |
charliermarsh
force-pushed
the
docs/flake8-errmsg
branch
2 times, most recently
from
cc43c54
to
393af04
Compare
charliermarsh
force-pushed
the
docs/flake8-errmsg
branch
from
393af04
to
bb334dd
Compare
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.
Related: