summaryrefslogtreecommitdiff
path: root/doc/user_guide
diff options
context:
space:
mode:
authorJace Browning <jacebrowning@gmail.com>2018-05-15 08:41:57 -0400
committerClaudiu Popa <pcmanticore@gmail.com>2018-05-15 08:41:57 -0400
commit656c17b5f30cad92a123688bde858948736ce478 (patch)
tree9070f77c137ccfeddaa733f87ac9751e058f9087 /doc/user_guide
parent2acaa2767378609aa3d65557761143258c67c053 (diff)
downloadpylint-git-656c17b5f30cad92a123688bde858948736ce478.tar.gz
Includes file paths in the default report format (#2088)
The default report format in mypy, pydocstyle, and other tools includes the file path so that the user of certain terminals (e.g. iTerm) can click on each warning to open that line in their editor. For example, here is what the default mypy output looks like: framework/views/billing.py:92: error: Incompatible return value type (got "View", expected "DashboardTab") With this new format, pylintoutput looks like: framework/views/dashboards.py:21:8: W0612: Unused variable 'x' (unused-variable) Note that some editors (e.g. Sublime Text) index columns from 1, so this will place the cursor one column to the left of the warning.
Diffstat (limited to 'doc/user_guide')
-rw-r--r--doc/user_guide/output.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/user_guide/output.rst b/doc/user_guide/output.rst
index 79d0af119..6da419139 100644
--- a/doc/user_guide/output.rst
+++ b/doc/user_guide/output.rst
@@ -39,9 +39,9 @@ For example, the former (pre 1.0) default format can be obtained with::
A few other examples:
-* the new default format::
+* the default format::
- {C}:{line:3d},{column:2d}: {msg} ({symbol})
+ {path}:{line}:{column}: {msg_id}: {msg} ({symbol})
* Visual Studio compatible format (former 'msvs' output format)::