summaryrefslogtreecommitdiff
path: root/doc/output.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/output.rst')
-rw-r--r--doc/output.rst24
1 files changed, 19 insertions, 5 deletions
diff --git a/doc/output.rst b/doc/output.rst
index 6617ac4..3a87547 100644
--- a/doc/output.rst
+++ b/doc/output.rst
@@ -24,20 +24,34 @@ obj
object within the module (if any)
msg
text of the message
+msg_id
+ the message code (eg. I0011)
symbol
- symbolic name of the message
+ symbolic name of the message (eg. locally-disabled)
C
one letter indication of the message category
category
fullname of the message category
-For exemple the default format can be obtained with::
+For exemple the former (pre 1.0) default format can be obtained with::
- pylint --msg-template='{sigle}:{line:3d},{column}: {obj}: {msg}'
+ pylint --msg-template='{msg_id}:{line:3d},{column}: {obj}: {msg}'
+
+A few other examples:
+
+* the new default format::
+
+ {C}:{line:3d},{column:2d}: {msg} ({symbol})
+
+* Visual Studio compatible format (former 'msvs' output format)::
+
+ {path}({line}): [{msg_id}{obj}] {msg}
+
+* Parseable (Emacs and all, former 'parseable' output format) format::
+
+ {path}:{line}: [{msg_id}({symbol}), {obj}] {msg}
-and a Visual Studio compatible format can be obtained with::
- pylint --msg-template='{path}({line}): [{sigle}{obj}] {msg}'
.. _Python new format syntax: http://docs.python.org/2/library/string.html#formatstrings