Add docstrings linting with 'pydocstyle' using 'flake8' #1483
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
mondeja
added
refactor
mondeja
added
the
documentation
mondeja
force-pushed
the
lint-docstrings
branch
from
550bc65 to
1ca547f
Compare
tburrows13
reviewed
Jan 22, 2021
There was a problem hiding this comment.
Very nice overall. This should make my job in #1482 easier (after a painful rebase/merge!). The only other thing I'm not sure about is indenting examples. I don't think it is necessary, but I think you've done that here? If I'm wrong, please ignore me!
Yes, I've found indented the examples of a function, but is fixed now. Let me know if you see something more wrong. |
tburrows13
approved these changes
Jan 22, 2021
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.
This pull request add configuration and installation for
flake8-docstringsandflake8-rst-docstrings. It ensures that docstring haven't common errors, that docstrings are written for public functions... unifying in general the code base.I've ignored some rules either because it generated too much work to correct them (
D100,D104) or are too much intrusive (D401, for example).Other minor changes are:
positioning.py.PIL_to_npimage.