summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTrevor Bekolay <tbekolay@gmail.com>2019-05-14 20:17:08 -0400
committerClaudiu Popa <pcmanticore@gmail.com>2019-09-12 14:23:19 +0200
commit20e432ebc0c7f760ca80e3700e64c00afb56236e (patch)
treedf69ebb3063eb96793cf80b683b88ff2e3f703a0 /doc
parentb758b549a702bf4ed5ff51178eea16a97bab702e (diff)
downloadpylint-git-20e432ebc0c7f760ca80e3700e64c00afb56236e.tar.gz
Add a command to list enabled/disabled messages
When enabling/disabling several messages and groups in a config file, it can be unclear which messages are actually enabled and which are disabled. This new command produces the final resolved lists of enabled/disabled messages, sorted by symbol but with the ID provided for use with `--help-msg`. This commit includes a test, documentation, and adding myself to the contributors list, as this is my first contribution.
Diffstat (limited to 'doc')
-rw-r--r--doc/user_guide/run.rst2
-rw-r--r--doc/whatsnew/2.4.rst13
2 files changed, 12 insertions, 3 deletions
diff --git a/doc/user_guide/run.rst b/doc/user_guide/run.rst
index ca7e3f16b..338a07064 100644
--- a/doc/user_guide/run.rst
+++ b/doc/user_guide/run.rst
@@ -119,6 +119,8 @@ Other useful global options include:
--output-format=<format> Select output format (text, json, custom).
--msg-template=<template> Modify text output message template.
--list-msgs Generate pylint's messages.
+--list-msgs-enabled Display a list of what messages are enabled and
+ disabled with the given configuration.
--full-documentation Generate pylint's full documentation, in reST
format.
diff --git a/doc/whatsnew/2.4.rst b/doc/whatsnew/2.4.rst
index 15fe03361..e5e5d86af 100644
--- a/doc/whatsnew/2.4.rst
+++ b/doc/whatsnew/2.4.rst
@@ -15,11 +15,11 @@ New checkers
* Added a new check, ``consider-using-sys-exit``
- This check is emitted when we detect that a quit() or exit() is invoked
+ This check is emitted when we detect that a quit() or exit() is invoked
instead of sys.exit(), which is the preferred way of exiting in program.
Close #2925
-
+
* Added a new check, ``arguments-out-of-order``
This check warns if you have arguments with names that match those in
@@ -125,7 +125,7 @@ New checkers
Other Changes
=============
-* Don't emit ``protected-access`` when a single underscore prefixed attribute is used
+* Don't emit ``protected-access`` when a single underscore prefixed attribute is used
inside a special method
Close #1802
@@ -208,3 +208,10 @@ would mean that `no-value-for-parameter` would not be raised for::
to control which logging string format style is valid.
To allow this, a new `fstr` value is valid for the `logging-format-style`
option.
+
+* ``--list-msgs-enabled`` command was added.
+
+When enabling/disabling several messages and groups in a config file,
+it can be unclear which messages are actually enabled and which are disabled.
+This new command produces the final resolved lists of enabled/disabled messages,
+sorted by symbol but with the ID provided for use with ``--help-msg``.