diff --git a/test-requirements.txt b/test-requirements.txt index 99901c7c2c..f061d62ffe 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,6 +3,8 @@ # process, which may cause wedges in the gate later. hacking<0.11,>=0.10.0 +pep257==0.7.0 # MIT License +flake8_docstrings==0.2.1.post1 bashate>=0.2 # Apache-2.0 # computes code coverage percentages diff --git a/tox.ini b/tox.ini index 9ad4fe371c..dc04e955d3 100644 --- a/tox.ini +++ b/tox.ini @@ -94,8 +94,25 @@ commands = python setup.py testr --slowest --testr-args='{posargs}' filename= *.py,keystone-all,keystone-manage show-source = true -# H405 multi line docstring summary not separated with an empty line -ignore = H405 +# H405: multi line docstring summary not separated with an empty line +# 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 docstrings should fit on one line with quotes. +# D202: No blank lines allowed after 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. +# D208: Docstring over indented. +# D210: No whitespaces allowed surrounding docstring text +# D300: Use """triple double quotes""" +# D400: First line should end with a period. +# D401: First line should be in imperative mood. +# D402: line should not be the function's "signature". +ignore = H405,D100,D101,D102,D103,D104,D105,D200,D202,D203,D204,D205,D208,D210,D300,D400,D401,D402 exclude=.venv,.git,.tox,build,dist,doc,*openstack/common*,*lib/python*,*egg,tools,vendor,.update-venv,*.ini,*.po,*.pot max-complexity=24