Commit Graph

5 Commits

Author SHA1 Message Date
Roberto Leinardi
2d21a408e1 Added missin Info type to doc 2018-09-04 08:02:10 +02:00
Jace Browning
656c17b5f3 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.
2018-05-15 08:41:57 -04:00
Michael Giuffrida
2d1faba269 Document score section and option in output.rst
Adds basic documentation for adjusting the evaluation output.

This option is important because it explains how to suppress all
output when the code is free of errors and warnings.
2017-10-12 09:33:15 +02:00
Claudiu Popa
660c15d58a
Fix typo. Close #1625 2017-08-15 11:08:41 +02:00
Claudiu Popa
31096db040 Move parts of the documentation into their own folder section. 2016-08-14 21:01:58 +03:00