DOC: Fix inconsistent spacing in some docstrings in _axes.py #28037
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
dstansby
approved these changes
Apr 7, 2024
There's pydocstyle
which AFAICS is active in flake8 through flake8-docstrings. But probably, they don't apply because the parameter lists are technically definition lists and they may not be covered by these rules. Semi-OT: I've noticed that pydocstyle (and with it flake8-docstrings) is deprecated. The recommended replacement is ruff. Mid-term we need to move there. |
timhoffm
approved these changes
Apr 7, 2024
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.
PR summary
Some of the docstrings in
_axes.pyhad the wrong amount of spacing (either 2 or 3 spaces) instead of 4. This PR makes them conform with the rest.