Merged
Conversation
MichaReiser
force-pushed
the
micha/unused-ignore-comment
branch
from
37868f8 to
dbdbd8d
Compare
MichaReiser
force-pushed
the
micha/unused-ignore-comment
branch
2 times, most recently
from
6ea4bfa to
1255dc7
Compare
Contributor
|
MichaReiser
requested review from
AlexWaygood,
carljm and
sharkdp
as code owners
MichaReiser
force-pushed
the
micha/file-level-type-ignore
branch
from
357825e to
ec700b8
Compare
MichaReiser
force-pushed
the
micha/unused-ignore-comment
branch
from
d83fc9b to
b32e668
Compare
carljm
approved these changes
Dec 22, 2024
MichaReiser
force-pushed
the
micha/file-level-type-ignore
branch
from
ec700b8 to
788bfd2
Compare
MichaReiser
force-pushed
the
micha/unused-ignore-comment
branch
3 times, most recently
from
f5520be to
968741c
Compare
MichaReiser
force-pushed
the
micha/unused-ignore-comment
branch
from
968741c to
5a12efd
Compare
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
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.
Summary
This PR implements a new Red Knot rule that reports unused
type: ignoreorknot: ignore[code]comments.The tricky part about this rule is that
unused-ignore-commentcan itself be suppressed by using an ignore comment.Ruff only supports suppressing
unused-noqawarnings with a file-levelnoqacomment. Unfortunately, wedon't support file-level ignore comments other than
type: ignorebut we also want to warn about unusedfile-level
type: ignorecomments.That's why this PR proposes that we allow suppressing
unused-ignore-commentbut only by usingknot: ignore[unused-ignore-comment].Open questions
Ruff calls the rule
unused-noqa, but I'm not sure ifunnecessaryoruselesswould be more fitting because you can't use an ignore code. But an ignore code can be useless (or unnecessary).Test Plan
Added mdtests