[pydoclint] Add docstring-missing-returns amd docstring-extraneous-returns (DOC201, DOC202)#12485
Merged
MichaReiser merged 13 commits intoastral-sh:mainfrom Jul 26, 2024
Merged
Conversation
CodSpeed Performance ReportMerging #12485 will not alter performanceComparing Summary
|
MichaReiser
approved these changes
Jul 24, 2024
Member
MichaReiser
left a comment
There was a problem hiding this comment.
Thanks. This overall looks good to me. I think there's a pre-existing issue around nested functions. I'm okay with merging the PR as is and doing a follow up pr to fix it or fix it in this pr.
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
Contributor
Author
|
All done |
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
Add
docstring-missing-returnsamddocstring-extraneous-returns(DOC201,DOC202). These rules check that the returns defined (or not) in the docstring of a function match its implementation.Part of #12434.
Test Plan
Test cases added.