From 9c4100b85d277b558143b1af9dc9ffdc37802e37 Mon Sep 17 00:00:00 2001 From: Dolph Mathews Date: Fri, 2 Oct 2015 03:24:59 +0000 Subject: 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. Related-Bug: 1501544 Change-Id: I01ebad7b70cf61dd80d3c06c6808d8178fbdd634 --- tox.ini | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'tox.ini') diff --git a/tox.ini b/tox.ini index cdc773e..2024e4a 100644 --- a/tox.ini +++ b/tox.ini @@ -25,7 +25,21 @@ commands = oslo_debug_helper {posargs} show-source = True # H405: Multi line docstrings should start with a one line summary followed by # 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 line required after class docstring +# D205: 1 blank line required between summary line and description +# D208: Docstring is over-indented +# 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,D208,D400,D401 exclude = .tox,dist,doc,*.egg,build,./pycadf/openstack/common [hacking] -- cgit v1.2.1