Enable Ruff D (pydocstyle) with pep257 convention #13326
Merged
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
Avasam
changed the title
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
AlexWaygood
reviewed
Jan 2, 2025
Co-authored-by: Alex Waygood <[email protected]>
…to Ruff-D-pep257
AlexWaygood
approved these changes
Jan 2, 2025
AlexWaygood
added a commit
that referenced
this pull request
Jan 2, 2025
Co-authored-by: Alex Waygood <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
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.
Ref #13295
https://docs.astral.sh/ruff/rules/#pydocstyle-d
https://docs.astral.sh/ruff/settings/#lint_pydocstyle_convention
https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings
I went with
pep257as the base convention as it is the one with minimal changes and configuration for typeshed.There are more rules that can be enabled (either manually, and/or by using a different base convention) but I think
pep257makes for a good start.Allows more consistency in how our own docstrings are written. Most rules are autofixable and only change whitespaces, so it's a lot like formatting our docstring (which Black wouldn't do since it does technically change the content).
Two currently enabled rules do a little bit more:
I pre-emptively disabled any rule that did more than whitespace changes to the content of docstrings from
*_pb2.pyifiles, since we should be matching upstream's docstrings.