-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[pydoclint
] Add docstring-missing-returns
amd docstring-extraneous-returns
(DOC201
, DOC202
)
#12485
Conversation
CodSpeed Performance ReportMerging #12485 will not alter performanceComparing Summary
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
All done |
Summary
Add
docstring-missing-returns
amddocstring-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.