Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[pydoclint] Add docstring-missing-returns amd docstring-extraneous-returns (DOC201, DOC202) #12485

Merged
merged 13 commits into from
Jul 26, 2024
Merged

[pydoclint] Add docstring-missing-returns amd docstring-extraneous-returns (DOC201, DOC202) #12485

merged 13 commits into from
Jul 26, 2024

Conversation

augustelalande
Copy link
Contributor

@augustelalande augustelalande commented Jul 24, 2024 •
edited
Loading

Summary

Add docstring-missing-returns amd docstring-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.

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Jul 24, 2024 •
edited
Loading

CodSpeed Performance Report

Merging #12485 will not alter performance

Comparing augustelalande:doc2xx (456db23) with augustelalande:doc2xx (16e30f2)

Summary

✅ 33 untouched benchmarks

@MichaReiser MichaReiser added rule Implementing or modifying a lint rule docstring Related to docstring linting or formatting preview Related to preview mode features labels Jul 24, 2024
MichaReiser
MichaReiser approved these changes Jul 24, 2024
View reviewed changes
Copy link
Member

@MichaReiser MichaReiser left a 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 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
@augustelalande
Copy link
Contributor Author

All done

@MichaReiser MichaReiser enabled auto-merge (squash) July 26, 2024 06:32
@MichaReiser MichaReiser merged commit 9f72f47 into astral-sh:main Jul 26, 2024
19 checks passed
@augustelalande augustelalande deleted the doc2xx branch July 26, 2024 15:04
@augustelalande augustelalande mentioned this pull request Jul 27, 2024
Merged
@BrewTestBot BrewTestBot mentioned this pull request Aug 2, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MichaReiser MichaReiser MichaReiser approved these changes

Assignees
No one assigned
Labels
docstring Related to docstring linting or formatting preview Related to preview mode features rule Implementing or modifying a lint rule
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@augustelalande @MichaReiser