[pydoclint] Deduplicate collected exceptions after traversing function bodies
#12642
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
AlexWaygood
added
rule
AlexWaygood
force-pushed
the
alex/dedupe-pydoclint
branch
from
57d7cbc to
1b4529b
Compare
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| DOC501 | 647 | 3 | 644 | 0 | 0 |
| }); | ||
| raised_exceptions.dedup_by(|left, right| { | ||
| left.qualified_name.segments() == right.qualified_name.segments() | ||
| }); |
There was a problem hiding this comment.
Could we use a BTreeSet instead, to get this for free?
There was a problem hiding this comment.
I don't think so, because we're storing ExceptionEntry objects in the Vec rather than QualifiedNames. ExceptionEntrys have two fields — one is a QualifiedName and the other is a TextRange. We want to make sure that no two ExceptionEntrys in the Vec have the same QualifiedName, regardless of whether they have the same TextRange or not
There was a problem hiding this comment.
It is possible to do this by implementing Hash for ExceptionEntry manually, and omitting TextRange. But probably not worth it, can create confusion.
AlexWaygood
force-pushed
the
alex/dedupe-pydoclint
branch
from
1b4529b to
0907b72
Compare
charliermarsh
approved these changes
Aug 2, 2024
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.
Summary
I noticed when looking through the ecosystem report for #12639 that a function like this will be flagged twice for not stating in its docstring that it raises
TypeError. We probably only need to emit one DOC501 violation for such a function:Test Plan
cargo test -p ruff_linter