From 3a82bcec1f6ecb45b039d785035534375099914d Mon Sep 17 00:00:00 2001 From: Dave Wilde Date: Tue, 20 Dec 2022 10:25:53 -0600 Subject: Fix pep8 gate This updates the test-requirements to a more recent flake8-docstrings version. I also added an ignore for __init__ methods, this may be something that we want to revisit but are not needed for now. We also slip in a little change that renames whitelist to allowlist. It is also a gate failure and thus is circular with the pep8 fix: neither can be merged separately. Change-Id: Id12f6e3b5d603531744d02f7bafab0b80696751e --- test-requirements.txt | 2 +- tox.ini | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/test-requirements.txt b/test-requirements.txt index 37e0ee8..513595d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,7 +3,7 @@ # process, which may cause wedges in the gate later. # Hacking already pins down pep8, pyflakes and flake8 hacking>=3.0.1,<3.1.0 # Apache-2.0 -flake8-docstrings==0.2.1.post1 # MIT +flake8-docstrings==1.6.0 # MIT coverage!=4.4,>=4.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD diff --git a/tox.ini b/tox.ini index c98a1d5..84613a7 100644 --- a/tox.ini +++ b/tox.ini @@ -17,7 +17,7 @@ commands = flake8 [testenv:docs] deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} -r{toxinidir}/doc/requirements.txt -whitelist_externals = +allowlist_externals = rm commands = rm -rf doc/build/html doc/build/doctrees @@ -48,6 +48,7 @@ show-source = True # D103: Missing docstring in public function # D104: Missing docstring in public package # D105: Missing docstring in magic method +# D107: Missing docstring in __init__ # 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 @@ -58,5 +59,5 @@ show-source = True # D401: First line should be in imperative mood # W503 line break before binary operator # W504 line break after binary operator -ignore = H405,D100,D101,D102,D103,D104,D105,D200,D202,D203,D204,D205,D208,D400,D401,W503,W504 +ignore = H405,D100,D101,D102,D103,D104,D105,D107,D200,D202,D203,D204,D205,D208,D400,D401,W503,W504 exclude = .tox,dist,doc,*.egg,build -- cgit v1.2.1