Merge "Add docstring validation"

test-requirements.txt

@@ -3,6 +3,7 @@
 # process, which may cause wedges in the gate later.
 
 hacking<0.11,>=0.10.0
+flake8_docstrings==0.2.1.post1
 
 coverage>=3.6
 discover

tox.ini

@@ -32,12 +32,24 @@ downloadcache = ~/cache/pip
 commands = oslo_debug_helper -t keystoneauth1/tests {posargs}
 
 [flake8]
-# NOTE(lhcheng): Even though we aren't ignoring any hacking checks, we have
-# to leave it assigned in the environment specification otherwise some error
-# checks will be ignored by default. If we need to ignore a specific hacking
-# check in the future, we will have to remove '___' from the ignore line.
-# See: http://flake8.readthedocs.org/en/latest/config.html#default
-ignore = ___
+# 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 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.
+# 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,D208,D211,D301,D400,D401
 show-source = True
 exclude = .venv,.tox,dist,doc,*egg,build,*openstack/common*