From dde50c23bc8f387508e7d3fed6e7c84e3d226e1e Mon Sep 17 00:00:00 2001 From: Ryan Roden-Corrent Date: Fri, 13 Oct 2017 07:44:26 -0400 Subject: [PATCH] Fix up pylint notes in configuring.asciidoc. - Use short form of pylint disable - Update the following code block as well - Add pylint ignore for missing-module-docstring --- doc/help/configuring.asciidoc | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/doc/help/configuring.asciidoc b/doc/help/configuring.asciidoc index f4996e16c..39a72201b 100644 --- a/doc/help/configuring.asciidoc +++ b/doc/help/configuring.asciidoc @@ -349,13 +349,15 @@ bind_chained('', 'clear-keychain', 'search') Avoiding flake8 errors ^^^^^^^^^^^^^^^^^^^^^^ -If you use an editor with flake8 and pylint integration which complains about -`c` and `config` being undefined or invalid, you can use: +If you use an editor with flake8 and pylint integration, it may have some +complaints about invalid names, undefined variables, or missing docstrings. +You can silence those with: [source,python] ---- -c = c # noqa: F821 pylint: disable=invalid-name,undefined-variable -config = config # noqa: F821 pylint: disable=invalid-name,undefined-variable +# pylint: disable=C0111 +c = c # noqa: F821 pylint: disable=E0602,C0103 +config = config # noqa: F821 pylint: disable=E0602,C0103 ---- For type annotation support (note that those imports aren't guaranteed to be @@ -363,8 +365,9 @@ stable across qutebrowser versions): [source,python] ---- +# pylint: disable=C0111 from qutebrowser.config.configfiles import ConfigAPI # noqa: F401 from qutebrowser.config.config import ConfigContainer # noqa: F401 -config = config # type: ConfigAPI # noqa: F821 -c = c # type: ConfigContainer # noqa: F821 +config = config # type: ConfigAPI # noqa: F821 pylint: disable=E0602,C0103 +c = c # type: ConfigContainer # noqa: F821 pylint: disable=E0602,C0103 ----