diff options
author | Daniel Neal <dan.r.neal@gmail.com> | 2020-05-27 12:59:57 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-27 21:59:57 +0200 |
commit | 1ad2f2550ca34f12da0a1065cd1e61cdeefba90b (patch) | |
tree | 83365474f299e73e9bc558d291d1623ec16cb502 | |
parent | 1fc490c0a1d0df5d4d6a64da0ccf2dd711b9bf67 (diff) | |
download | pylint-git-1ad2f2550ca34f12da0a1065cd1e61cdeefba90b.tar.gz |
Add an faq on message to disable to avoid duplicates w/ other popular linters
* Faq detailing which messages to disable to avoid duplicates w/ other linters (#3647)
* Add name to contributors
* Update ChangeLog
* Update faq.rst
* Extend underline
-rw-r--r-- | CONTRIBUTORS.txt | 2 | ||||
-rw-r--r-- | ChangeLog | 1 | ||||
-rw-r--r-- | doc/faq.rst | 23 |
3 files changed, 26 insertions, 0 deletions
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 350b7d1c0..4dc47f901 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -383,3 +383,5 @@ contributors: * Andrew J. Simmons (anjsimmo): contributor * Damien Baty: contributor + +* Daniel R. Neal (danrneal): contributer @@ -20,6 +20,7 @@ Release date: TBA * Add `super-with-arguments` check for flagging instances of Python 2 style super calls. +* Add an faq detailing which messages to disable to avoid duplicates w/ other popular linters What's New in Pylint 2.5.3? =========================== diff --git a/doc/faq.rst b/doc/faq.rst index 953e3776d..a777b7c0a 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -186,6 +186,29 @@ for not being included as default messages. But most of the disabled messages are from the Python 3 porting checker, which is disabled by default. It needs special activation with the ``--py3k`` flag. +4.8 I am using another popular linter alongside pylint. Which messages should I disable to avoid duplicates? +------------------------------------------------------------------------------------------------------------ + +pycodestyle_: unneeded-not, line-too-long, unnecessary-semicolon, trailing-whitespace, missing-final-newline, bad-indentation, multiple-statements, bare-except + +pyflakes_: undefined-variable, unused-import, unused-variable + +mccabe_: too-many-branches + +pydocstyle_: missing-module-docstring, missing-class-docstring, missing-function-docstring + +pep8-naming_: invalid-name, bad-classmethod-argument, bad-mcs-classmethod-argument, no-self-argument + +flake8-import-order_: wrong-import-order + +.. _`pycodestyle`: https://github.com/PyCQA/pycodestyle +.. _`pyflakes`: https://github.com/PyCQA/pyflakes +.. _`mccabe`: https://github.com/PyCQA/mccabe +.. _`pydocstyle`: https://github.com/PyCQA/pydocstyle +.. _`pep8-naming`: https://github.com/PyCQA/pep8-naming +.. _`flake8-import-order`: https://github.com/PyCQA/flake8-import-order + + 5. Classes and Inheritance ========================== |