rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix up pylint notes in configuring.asciidoc.

Browse Source 
- Use short form of pylint disable
- Update the following code block as well
- Add pylint ignore for missing-module-docstring
This commit is contained in:
Ryan Roden-Corrent 2017-10-13 07:44:26 -04:00
parent 69ced4e033
commit dde50c23bc
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/help/configuring.asciidoc
View File

@ -349,13 +349,15 @@ bind_chained('<Escape>', '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
----