[pydoclint] Implement docstring-missing-exception and docstring-extraneous-exception (DOC501, DOC502)#11471
Merged
charliermarsh merged 25 commits intoastral-sh:mainfrom Jul 20, 2024
Merged
Conversation
CodSpeed Performance ReportMerging #11471 will degrade performances by 97.48%Comparing Summary
Benchmarks breakdown
|
Contributor
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| DAR401 | 2237 | 2237 | 0 | 0 | 0 |
| DAR402 | 2 | 2 | 0 | 0 | 0 |
Formatter (stable)
✅ ecosystem check detected no format changes.
Formatter (preview)
✅ ecosystem check detected no format changes.
charliermarsh
added
rule
|
If this PR is accepted, will this preclude |
Contributor
Author
|
I'm not opposed to using pydocstyle instead, but I'll wait until I get a review from the ruff team to change anything. |
charliermarsh
approved these changes
Jul 17, 2024
Member
charliermarsh
left a comment
charliermarsh
left a comment
There was a problem hiding this comment.
Nice, this looks great. I'll make a few tweaks and merge today.
Contributor
Author
|
@charliermarsh where do you stand on darglint vs pydoclint as mentioned above |
Member
|
Honestly, finding it hard to have a strong opinion on it... What do you think? Absent other opinions, let's run with |
Contributor
Author
|
Sounds reasonable to me |
augustelalande
changed the title
darglint] Implement docstring-missing-exception and docstring-extraneous-exception (DAR401, DAR402)pydoclint] Implement docstring-missing-exception and docstring-extraneous-exception (DOC501, DOC502)
crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs
Outdated
Show resolved
Hide resolved
T-256
reviewed
Jul 19, 2024
crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs
Outdated
Show resolved
Hide resolved
ddelange
reviewed
Jul 19, 2024
| impl<'a> DocstringEntries<'a> { | ||
| /// Return the raised exceptions for the docstring, or `None` if the docstring does not contain | ||
| /// a `Raises` section. | ||
| fn from_sections(sections: &'a SectionContexts, style: SectionStyle) -> Option<Self> { |
Member
There was a problem hiding this comment.
I changed this to return None when there's no section, so we didn't have to unwrap the raised_exceptions_range. Feel free to revert in future PRs if that gets in the way, though I think something like that is useful to get rid of the unwrap.
Contributor
|
Do we need to update title and description of #458 to keep tracking future implementations for this plugin? |
Contributor
Author
|
I'm thinking to open a new issue to track |
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
5 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
These are the first rules implemented as part of #458, but I plan to implement more.
Specifically, this implements
docstring-missing-exceptionwhich checks for raised exceptions not documented in the docstring, anddocstring-extraneous-exceptionwhich checks for exceptions in the docstring not present in the body.Test Plan
Test fixtures added for both google and numpy style.