[WIP] Pre-Commit: Docformatter #119
Closed
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
ax3l
force-pushed
the
ci-docformatter
branch
3 times, most recently
from
f791e41 to
732de4c
Compare
Merged
ax3l
force-pushed
the
ci-docformatter
branch
4 times, most recently
from
8c49414 to
72d1cda
Compare
Add [docformatter](https://github.com/PyCQA/docformatter) to auto-format Function/Class docstrings according to numpy style. Reference: - https://docformatter.readthedocs.io/en/latest/requirements.html#current-implementation
for more information, see https://pre-commit.ci
|
This tool seems to be quite new and has a nice interplay with The 1.5.1 version and even 1.6.0 version seem to not yet check styles such as numpy. Status: |
|
Since PyCQA/docformatter#60 is still a far time out, we will go with #120 for now. |
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.
Testing docformatter to auto-format Function/Class docstrings according to numpy style.
Reference:
Alternatives to try: