Make bugbear slightly more polite #298
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
Bugbear is great at catching bugs in our code, but can come across a bit rude when commenting on pull requests 😂 Obviously it's a robot, but we like to encourage polite discourse
cooperlees
approved these changes
Oct 17, 2022
| @@ -1192,8 +1192,8 @@ def visit_Lambda(self, node): | |||
| } | |||
| B015 = Error( | |||
| message=( | |||
| "B015 Pointless comparison. This comparison does nothing but waste " | |||
| "CPU instructions. Either prepend `assert` or remove it." | |||
There was a problem hiding this comment.
I personally feel the blunt nature of the message makes it clearer of what the check looks for.
The new message will make people think into it more and possibly over complicate their actions. But open to others thoughts …
There was a problem hiding this comment.
I definitely see the tradeoff here, and agree that the cause of the error should be the first thing the user sees. The aim with the change of wording was to retain that, while softening the order to a suggestion.
Co-authored-by: Cooper Lees <me@cooperlees.com>
cooperlees
approved these changes
Oct 19, 2022
|
@cooperlees no probs! Thanks for accepting the change, hope your holidays were excellent |
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.
Bugbear is great at catching bugs in our code, but can come across a bit rude when commenting on pull requests 😂 Obviously it's a robot, but we like to encourage polite discourse