Add pydocstyle checks to flake8#14063
Merged
Merged
Conversation
9ca6983 to
ae96b50
Compare
Member
|
I'm happy with this, but I figure this should be discuss by more than one person. |
Member
|
@ivanov Care to comment on that? 😄 |
tacaswell
approved these changes
Apr 29, 2019
Merged
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
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
This enables docstring checks using pydocstyle. I've integrated the checks into flake8 via the flake8-docstrings plugin. This has two advantages over running
pydocstylestandalone:To keep it simple in the beginning, this PR ignores most pydocstyle error codes. Only D201 and D206 are currently checked. We can subsequently enable more checks as we go along.
Done The error was found in CI, and I've pushed the fix. - It works 🎉