Add docformatter to pre-commit hooks - #914
Merged
Merged
Conversation
syssi
reviewed
Jan 20, 2021
4 tasks
syssi
approved these changes
Jan 20, 2021
rytilahti
commented
Jan 20, 2021
syssi
approved these changes
Jan 20, 2021
Merged
xvlady
pushed a commit
to xvlady/python-miio
that referenced
this pull request
May 9, 2021
* Add docformatter to pre-commit hooks * Add version pinning for docformatter * Update poetry.lock * Improve docstring formatting for some cases where docformatter didn't do a nice job
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
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.
Docformatter is something like black but for docstring formatting: https://github.com/myint/docformatter
This PR adds it to the pre-commit hooks, and mass-converts the whole code base using it. If there are some cases where the docstring summary should include some text (e.g., for click), these needs to be modified manually.