-
Notifications
You must be signed in to change notification settings - Fork 6
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
Enforce correct numpy docstring formatting with ruff.pydocstyle #74
Merged
adamamer20
merged 34 commits into
main
from
73-enforce-numpy-docstring-formatting-with-ruffpydocstyle
Aug 24, 2024
Merged
Enforce correct numpy docstring formatting with ruff.pydocstyle #74
adamamer20
merged 34 commits into
main
from
73-enforce-numpy-docstring-formatting-with-ruffpydocstyle
Aug 24, 2024
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
Codecov ReportAttention: Patch coverage is
|
adamamer20
added
docs
Improvements or additions to documentation
ci
Changes to CI configuration files and scripts.
labels
Aug 24, 2024
rht
approved these changes
Aug 24, 2024
cc: @EwoutH we should do this for core Mesa as well. |
adamamer20
deleted the
73-enforce-numpy-docstring-formatting-with-ruffpydocstyle
branch
August 24, 2024 18:35
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.
This PR adds D rules with the numpy docstring convention to ruff and modifies files to comply with the new rules.
This allows for complete and consistent API documentation deployment with sphinx.
NOTE: I had to ignore D101, D102, D105 because ruff doesn't handle inheritance well currently (see astral-sh/ruff#2413)