This repository was archived by the owner on Apr 16, 2023. It is now read-only.
Fix flake8-docstring warnings #31
Merged
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
added 3 commits
October 8, 2014 21:13
* The first line should be in imperative mood.
* Avoid possibility that __all__ can be mutated confusing flake8-docstrings
* The first line should end with a full stop.
* Omit docstrings for setUp methods in TestCases * D102: Public method docstring missing. * D102: Public function docstring missing.
conman/nav_tree/tests/test_models.py
Outdated
Owner
|
Thanks again for this |
added 6 commits
October 8, 2014 23:42
Disable flake8 warnings for D100, D203 and D204 * D100: Module docstring missing. * D203: 1 blank line required before class docstring. * D204: 1 blank line required after class docstring.
* D200: One-line docstrings should fit on one line with quotes.
* Omit docstrings for test classes. * D101: Public class docstring missing.
* Allow use of flake8-docstrings locally without causing travis build failures.
docstring_requirements.txt
Outdated
Collaborator
Author
There was a problem hiding this comment.
@meshy What do you think of the idea of adding flake8-docstrings in a separate requirements file? This way we can run the docstring checks while developing, but don't need to worry about D101, D102 and D103 (missing docstrings) in travis runs.
Owner
There was a problem hiding this comment.
Perhaps it would be better to add it to the normal test_requirements, and remove it for travis?
Collaborator
Author
|
@meshy Review? |
Conflicts: conman/redirects/tests/factories.py
LilyFirefly
force-pushed
the
flake8-docstring
branch
from
de74d92 to
ffe3196
Compare
* Explicitly remove flake8-docstrings from travis builds
LilyFirefly
force-pushed
the
flake8-docstring
branch
from
ffe3196 to
9f60edc
Compare
conman/cms/urls.py
Outdated
Owner
There was a problem hiding this comment.
This seems to be something of a repetition.
Owner
|
Awesome work, Ian, thanks very much! I'll make sure to install the plugin, and to try not to introduce any more of these |
Collaborator
Author
|
Heh! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 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.
Related to #30.