From 7bd4c3aaed375068e71744f4c7bb6184ebe3fd25 Mon Sep 17 00:00:00 2001 From: Artom Lifshitz Date: Thu, 14 Oct 2021 10:42:41 -0400 Subject: [PATCH] hacking: Ignore H405 This patch proposes to ignore hacking H405, "multi line docstring summary not separated with an empty line". This arbitrarily enforces "title" lines for docstring that are more than 1 line, meaning a simple doctring that needs just 2 lines will either need to be condensed into a single line, or expanded to include a "title" and a longer explanation paragraph underneath. This does not appear to bring much value. Change-Id: I1978c73ab6eda1dce85c96b612c4c5bff286efc6 --- tox.ini | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index efdaacc2ad..29ed76caca 100644 --- a/tox.ini +++ b/tox.ini @@ -347,7 +347,8 @@ import_exceptions = tempest.services # E123 skipped because it is ignored by default in the default pep8 # E129 skipped because it is too limiting when combined with other rules # W504 skipped because it is overeager and unnecessary -ignore = E125,E123,E129,W504 +# H405 skipped because it arbitrarily forces doctring "title" lines +ignore = E125,E123,E129,W504,H405 show-source = True exclude = .git,.venv,.tox,dist,doc,*egg,build enable-extensions = H106,H203,H904