Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an faq detailing which messages to disable to avoid duplicates w/ other popular linters #3647

Merged
merged 7 commits into from
May 27, 2020
Merged

Add an faq detailing which messages to disable to avoid duplicates w/ other popular linters #3647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
866968b
Faq detailing which messages to disable to avoid duplicates w/ other …
danrneal May 27, 2020
f766643
Add name to contributors
danrneal May 27, 2020
c6b8275
Update ChangeLog
danrneal May 27, 2020
1b5d0a2
Update faq.rst
danrneal May 27, 2020
bf48ea2
Extend underline
danrneal May 27, 2020
6de5952
Add links to PyCQA linters and remove removed messages
danrneal May 27, 2020
ef8f447
Add forgotten link
danrneal May 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTORS.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,3 +383,5 @@ contributors:
* Andrew J. Simmons (anjsimmo): contributor

* Damien Baty: contributor

* Daniel R. Neal (danrneal): contributer
1 change: 1 addition & 0 deletions ChangeLog
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?
===========================
Expand Down
23 changes: 23 additions & 0 deletions doc/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
==========================

Expand Down