Skip to content

Commit

Permalink
Document that report generation disables cache (#14402)
Browse files Browse the repository at this point in the history
#6076 made report generation disable cache but we didn't document it.
  • Loading branch information
ikonst authored Jan 6, 2023
1 parent ca66805 commit 25ccdfc
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/source/config_file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ section of the command line docs.
line. Mypy *will* recursively type check any submodules of the provided
package. This flag is identical to :confval:`modules` apart from this
behavior.

This option may only be set in the global section (``[mypy]``).

.. confval:: exclude
Expand Down Expand Up @@ -901,6 +901,12 @@ Report generation
If these options are set, mypy will generate a report in the specified
format into the specified directory.

.. warning::

Generating reports disables incremental mode and can significantly slow down
your workflow. It is recommended to enable reporting only for specific runs
(e.g. in CI).

.. confval:: any_exprs_report

:type: string
Expand Down

0 comments on commit 25ccdfc

Please sign in to comment.