Enable docsting linting in ruff and cleans up some docstrings #164
Conversation
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
StephenNneji
force-pushed
the
enable_docstring_linting
branch
from
b0a9a97 to
ccfb684
Compare
StephenNneji
force-pushed
the
enable_docstring_linting
branch
from
ccfb684 to
61b3869
Compare
DrPaulSharp
approved these changes
Dec 4, 2025
Collaborator
There was a problem hiding this comment.
All looks good. As an extra, I've added a commit that makes some simple changes to resolve the rule D401 (whilst keeping it on the "ignore" list), which also helps make the docstrings more consistent with each other. Have a look and let me know what you think.
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.
This enables some linting on docstrings. Ruff currently does not have options to check arguments in numpy docstring (astral-sh/ruff#12434) some checks are in beta or preview mode. We might have to use another package such as pydoclint in the interim.