summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEmile Anclin <emile.anclin@logilab.fr>2010-10-25 15:50:34 +0200
committerEmile Anclin <emile.anclin@logilab.fr>2010-10-25 15:50:34 +0200
commita004b900ea8a67ef4fabcc68a4c31aa35f4807ad (patch)
tree4ffbc9cc7e8a98f5590c43227152adf1c403b602 /doc
parent110fe0299bd93b29d196464933aec406bfbb8207 (diff)
downloadpylint-git-a004b900ea8a67ef4fabcc68a4c31aa35f4807ad.tar.gz
doc: update FAQ, quickstart, beginner_pylint_tutorial
Diffstat (limited to 'doc')
-rw-r--r--doc/FAQ.txt6
-rw-r--r--doc/beginner_pylint_tutorial.txt14
-rw-r--r--doc/quickstart.txt17
3 files changed, 17 insertions, 20 deletions
diff --git a/doc/FAQ.txt b/doc/FAQ.txt
index 65da31d36..30da7ac86 100644
--- a/doc/FAQ.txt
+++ b/doc/FAQ.txt
@@ -150,7 +150,7 @@ the rc file
For example::
- pylint --disable-msg=W0702,C0103 --class-rgx='[A-Z][a-z]+' --generate-rcfile
+ pylint --disable=W0702,C0103 --class-rgx='[A-Z][a-z]+' --generate-rcfile
3.4 I'd rather not run Pylint from the command line. Can I integrate it with my editor?
---------------------------------------------------------------------------------------
@@ -187,7 +187,7 @@ http://www.wingware.com/doc/edit/pylint
-----------------------------------------------------------
Yes, this feature has been added in pylint 0.11. This may be done by
-adding "#pylint: disable-msg=W0123,E4567" at the desired block level
+adding "#pylint: disable=W0123,E4567" at the desired block level
or at the end of the desired line of code
@@ -230,7 +230,7 @@ Yes, you can disable or enable (globally disabled) messages at the
module level by adding the corresponding option in a comment at the
top of the file: ::
- # pylint: disable-msg=W0401, E0202
+ # pylint: disable=W0401, E0202
# pylint: enable-msg=C0302
4.5 What is the format of the configuration file?
diff --git a/doc/beginner_pylint_tutorial.txt b/doc/beginner_pylint_tutorial.txt
index b751d3a96..ed0e0ac5e 100644
--- a/doc/beginner_pylint_tutorial.txt
+++ b/doc/beginner_pylint_tutorial.txt
@@ -54,13 +54,13 @@ idea of the arguments available to you. Do that now, i.e.: ::
A couple of the options that we'll focus on here are: ::
Master:
- --rcfile=<file>
+ --generate-rcfile=<file>
Commands:
--help-msg=<msg-id>
Commands:
--help-msg=<msg-id>
Message control:
- --disable-msg=<msg-ids>
+ --disable=<msg-ids>
Reports:
--files-output=<y_or_n>
--reports=<y_or_n>
@@ -302,7 +302,7 @@ may not support that code so my code may break in the future. There are 5 C0103
messages that we will get to later. Lastly, I violated the convention of using
spaces around an operator such as "=" so I'll fix that too. To sum up, I'll add
a docstring to line 2, put spaces around the = sign on line 16 and use the
-"--disable-msg=W0402" to ignore the deprecation warning.
+"--disable=W0402" to ignore the deprecation warning.
Here's the updated code: ::
@@ -334,9 +334,9 @@ Here's the updated code: ::
26
27 print encoded
-And here's what happens when we run it with our --disable-msg=W0402 option: ::
+And here's what happens when we run it with our --disable=W0402 option: ::
- robertk01 Desktop$ pylint --reports=n --include-ids=y --disable-msg=W0402 simplecaeser.py
+ robertk01 Desktop$ pylint --reports=n --include-ids=y --disable=W0402 simplecaeser.py
No config file found, using default configuration
************* Module simplecaeser
C0103: 7: Invalid name "shift" (should match (([A-Z_][A-Z1-9_]*)|(__.*__))$)
@@ -345,7 +345,7 @@ And here's what happens when we run it with our --disable-msg=W0402 option: ::
C0103: 10: Invalid name "letters" (should match (([A-Z_][A-Z1-9_]*)|(__.*__))$)
C0103: 11: Invalid name "encoded" (should match (([A-Z_][A-Z1-9_]*)|(__.*__))$)
-Nice! We're down to just the C0103 messages.
+Nice! We're down to just the C0103 messages.
There are fairly well defined conventions around naming things like instance
variables, functions, classes, etc. The conventions focus on the use of
@@ -366,7 +366,7 @@ regular expression (a-z versus A-Z).
If we run that rule using a --const-rgx='[a-z\_][a-z0-9\_]{2,30}$' option, it
will now be quite quiet: ::
- robertk01 Desktop$ pylint --reports=n --include-ids=y --disable-msg=W0402 --const-rgx='[a-z_][a-z0-9_]{2,30}$' simplecaeser.py
+ robertk01 Desktop$ pylint --reports=n --include-ids=y --disable=W0402 --const-rgx='[a-z_][a-z0-9_]{2,30}$' simplecaeser.py
No config file found, using default configuration
Regular expressions can be quite a beast so take my word on this particular
diff --git a/doc/quickstart.txt b/doc/quickstart.txt
index 3e9fd6267..c32034870 100644
--- a/doc/quickstart.txt
+++ b/doc/quickstart.txt
@@ -161,11 +161,14 @@ First of all, we have two basic (but useful) options.
-h, --help show help about the command line options
Pylint is architectured around several checkers. By default all
-checkers are enabled. You can disable a specific checker by specifying
-``--enable-<checker>=n``, or disable all checkers using
-``--disable-all`` and afterwards enable specific checkers with
-``--enable-<checker>=y``. See the list of available features_ for a
+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
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``
Each checker has some specific options, which can take either a yes/no
value, an integer, a python regular expression, or a comma separated
@@ -192,12 +195,6 @@ Other useful global options include:
--comment=y_or_n Add a comment according to your evaluation note.
--parseable=y_or_n Use a parseable output format.
--html=y_or_n Use HTML as output format instead of text.
---enable-msg=msgids Enable the given messages.
---disable-msg=msgids Disable the given messages.
---enable-msg-cat=cats Enable all messages in the given categories.
---disable-msg-cat=cats Disable all messages in the given categories.
-
-
Bug reports
-----------