Skip to content

Document how to suppress colorized output and summary line #7448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 4, 2019
Merged

Document how to suppress colorized output and summary line #7448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
21d39b2
config_file.rst: Document how to suppress colorized output and summar…
tapaswenipathak Sep 3, 2019
3e56c78
command_line.rst: Document colorized output and summary line
tapaswenipathak Sep 4, 2019
1d7aee6
Remove long snippet and add description
tapaswenipathak Sep 4, 2019
e1afb05
Rephrase description
tapaswenipathak Sep 4, 2019
18ff3d6
Small rewording
ilevkivskyi Sep 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/source/command_line.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,13 @@ in error messages.

main.py:12:9: error: Unsupported operand types for / ("int" and "str")

``--no-color-output``
This flag will disable color output in error messages, enabled by default.

``--no-error-summary``
This flag will disable error summary. By default mypy shows a summary line
including total number of errors, number of files with errors, and number
of files checked.

.. _incremental:

Expand Down
5 changes: 5 additions & 0 deletions docs/source/config_file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,11 @@ section of the command line docs.
``show_column_numbers`` (bool, default False)
Shows column numbers in error messages.

``color_output`` (bool, default True)
Shows error messages with color enabled.

``error_summary`` (bool, default True)
Shows a short summary line after error messages.

Advanced options
----------------
Expand Down