Skip to content

Commit d310b2d

Browse files
committed
docs: Update docs for pretty-by-default behavior
This commit updates the user-facing documentation to reflect that pretty-printing is now the default output format. - The `--pretty` flag documentation in `command_line.rst` has been replaced with documentation for the new `--no-pretty` flag. - The `config_file.rst` documentation for the `pretty` option has been updated to state that its default is now `True`. Fixes #19108.
1 parent 9940678 commit d310b2d

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

docs/source/command_line.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -910,10 +910,10 @@ in error messages.
910910

911911
See :ref:`error-codes` for more information.
912912

913-
.. option:: --pretty
913+
.. option:: --no-pretty
914914

915-
Use visually nicer output in error messages: use soft word wrap,
916-
show source code snippets, and show error location markers.
915+
Disable pretty error messages and use the old, plain output format.
916+
Pretty-printing is enable by default.
917917

918918
.. option:: --no-color-output
919919

docs/source/config_file.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -896,10 +896,11 @@ These options may only be set in the global section (``[mypy]``).
896896
.. confval:: pretty
897897

898898
:type: boolean
899-
:default: False
899+
:default: True
900900

901901
Use visually nicer output in error messages: use soft word wrap,
902902
show source code snippets, and show error location markers.
903+
Pretty printing is enabled by default, but can be disabled.
903904

904905
.. confval:: color_output
905906

0 commit comments

Comments
 (0)