diff options
| author | Dolph Mathews <dolph.mathews@gmail.com> | 2015-10-01 16:59:36 +0000 |
|---|---|---|
| committer | lin-hua-cheng <os.lcheng@gmail.com> | 2015-11-09 19:27:47 -0800 |
| commit | 5fa4f79e57501efa3d3d5b13a3adf18f727b0731 (patch) | |
| tree | 3ad10560bff052f8fad8bcb3c7975c7f0e007e8b /tox.ini | |
| parent | eb77abd77a25baa556de4df527404b907748d3c6 (diff) | |
| download | python-keystoneclient-5fa4f79e57501efa3d3d5b13a3adf18f727b0731.tar.gz | |
Add docstring validation
This introduces a linter for PEP257 to avoid trivial nitpicking of
docstrings in code reviews. Because flake8_docstrings simply provides a
plugin to add pep257 to flake8, you can run it via `tox -e pep8`.
PEP257 checks which we are currently violating are ignored in tox.ini.
We can remove them from the ignored list as they are fixed.
Change-Id: I01ebad7b70cf61dd80d3c06c6808d8178fbdd634
Related-Bug: 1501544
Depends-On: I60adf0dca4aa32f4ef6bca61250b375c8a3703c6
Diffstat (limited to 'tox.ini')
| -rw-r--r-- | tox.ini | 19 |
1 files changed, 18 insertions, 1 deletions
@@ -40,7 +40,24 @@ commands = bandit -c bandit.yaml -r keystoneclient -n5 -p keystone_conservative [flake8] # H405: multi line docstring summary not separated with an empty line -ignore = H405 +# D100: Missing docstring in public module +# D101: Missing docstring in public class +# D102: Missing docstring in public method +# D103: Missing docstring in public function +# D104: Missing docstring in public package +# D105: Missing docstring in magic method +# D200: One-line docstring should fit on one line with quotes +# D202: No blank lines allowed after function docstring +# D203: 1 blank required before class docstring. +# D204: 1 blank required after class docstring +# D205: Blank line required between one-line summary and description. +# D207: Docstring is under-indented +# D208: Docstring is over-indented +# D211: No blank lines allowed before class docstring +# D301: Use r”“” if any backslashes in a docstring +# D400: First line should end with a period. +# D401: First line should be in imperative mood. +ignore = H405,D100,D101,D102,D103,D104,D105,D200,D202,D203,D204,D205,D207,D208,D211,D301,D400,D401 show-source = True exclude = .venv,.tox,dist,doc,*egg,build,*openstack/common* |