summaryrefslogtreecommitdiff
path: root/doc/output.rst
diff options
context:
space:
mode:
authorJames Broadhead <jamesbroadhead@gmail.com>2013-09-24 10:06:36 +0100
committerJames Broadhead <jamesbroadhead@gmail.com>2013-09-24 10:06:36 +0100
commit27a2d1f7cea1dab7837d9aaaca3ef63a0b51b645 (patch)
tree93f62643847a98615b452e831c74fab4011af58c /doc/output.rst
parentedcddebadd990e43a30f7a07b8efca0a02646964 (diff)
downloadpylint-27a2d1f7cea1dab7837d9aaaca3ef63a0b51b645.tar.gz
Update help docs for msg-format to include {msg_id}
Diffstat (limited to 'doc/output.rst')
-rw-r--r--doc/output.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/output.rst b/doc/output.rst
index 6617ac4..e698271 100644
--- a/doc/output.rst
+++ b/doc/output.rst
@@ -24,8 +24,10 @@ 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
@@ -33,11 +35,11 @@ category
For exemple the 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}'
and a Visual Studio compatible format can be obtained with::
- pylint --msg-template='{path}({line}): [{sigle}{obj}] {msg}'
+ pylint --msg-template='{path}({line}): [{msg_id}{obj}] {msg}'
.. _Python new format syntax: http://docs.python.org/2/library/string.html#formatstrings