diff options
author | Alexandre Fayolle <afayolle.ml@free.fr> | 2012-10-03 07:23:48 +0200 |
---|---|---|
committer | Alexandre Fayolle <afayolle.ml@free.fr> | 2012-10-03 07:23:48 +0200 |
commit | ca56dc268c382b9b81368e08d60ff8a17ec4ce53 (patch) | |
tree | f6586adf8415255f59f329462907440ce68bd91c /doc | |
parent | b6cb531be7f3398944afd14b9a475147bbef53d5 (diff) | |
download | pylint-ca56dc268c382b9b81368e08d60ff8a17ec4ce53.tar.gz |
add support for --disable=all option (closes: #105327)
updated the documentation accordingly
deprecate 'disable-all' as an inline directive in favor of 'skip-file'
Diffstat (limited to 'doc')
-rw-r--r-- | doc/FAQ.txt | 16 | ||||
-rw-r--r-- | doc/manual.txt | 6 | ||||
-rw-r--r-- | doc/quickstart.txt | 7 |
3 files changed, 24 insertions, 5 deletions
diff --git a/doc/FAQ.txt b/doc/FAQ.txt index 992190a..e61549a 100644 --- a/doc/FAQ.txt +++ b/doc/FAQ.txt @@ -252,13 +252,27 @@ No, starting from 0.25.3, you can use symbolic names for messages:: You can show these symbols in the output with the `-sy` option. +4.7 How can I tell Pylint to never check a given module? +-------------------------------------------------------- + +With pylint < 0.25, add "#pylint: disable-all" at the beginning of the +module. Pylint 0.26.1 and up have renamed that directive to +"#pylint: skip-file" (but the first version will be kept for backward +compatibility). + +In order to ease finding which modules are ignored a Information-level +message I0013 is emited. With recent versions of Pylint, if you use +the old syntax, an additional I0014 message is emited. + + + 5. Classes and Inheritance ========================== 5.1 When is pylint considering a class as an interface? ------------------------------------------------------- -A class is considered as an interface if there is a class named "Interface" +A class is considered as an interface if there is a class named "Interface" somewhere in its inheritance tree. 5.2 When is pylint considering that a class is implementing a given interface? diff --git a/doc/manual.txt b/doc/manual.txt index 98f6065..3bb049f 100644 --- a/doc/manual.txt +++ b/doc/manual.txt @@ -286,6 +286,10 @@ description of provided checkers with their functionalities. The ``--disable`` and ``--enable`` options can be used with comma separated lists mixing checkers, message ids and categories like ``-d C,W,E0611,design`` +It is possible to disable all messages with ``--disable=all``. This is +useful to enable only a few checkers or a few messages by first +disabling everything, and then re-enabling only what you need. + Each checker has some specific options, which can take either a yes/no value, an integer, a python regular expression, or a comma separated list of values (which are generally used to override a regular @@ -324,7 +328,7 @@ What pylint says is not to be taken as gospel. While getting as few false positives for errors as possible is a goal for us -- and python makes it hard enough, it is not the case for warnings. -:Quoting Alexandre: +:Quoting Alexandre Fayolle: My usage pattern for pylint is to generally run pylint -e quite often to get stupid errors flagged before launching an application (or before committing). I generally run pylint with all the bells and whistles diff --git a/doc/quickstart.txt b/doc/quickstart.txt index c320348..a50989e 100644 --- a/doc/quickstart.txt +++ b/doc/quickstart.txt @@ -163,9 +163,10 @@ First of all, we have two basic (but useful) options. Pylint is architectured around several checkers. By default all checkers are enabled. You can disable a specific checker or some of its messages or messages categories by specifying -``--disable=<id>``. A more general disable can be enabled with -or disable all checkers using -``--enable=w<id>``. See the list of available features_ for a +``--disable=<id>``. If you want to enable only some checkers or some +message ids, first use ``--disable=all`` then +``--enable=<id>`` with <id> being a comma separated list of checker +names and message identifiers. See the list of available features_ for a description of provided checkers with their functionalities. The ``--disable`` and ``--enable`` options can be used with comma separated lists mixing checkers, message ids and categories like ``-d C,W,E0611,design`` |