From 692a1dfb3405dad63da7b7a9366cd47b1b9945da Mon Sep 17 00:00:00 2001 From: Ilya Konstantinov Date: Thu, 5 Jan 2023 22:27:34 -0500 Subject: [PATCH] Document that report generation disables cache --- docs/source/config_file.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/source/config_file.rst b/docs/source/config_file.rst index abaec31c6888..3b96e6bd7a5a 100644 --- a/docs/source/config_file.rst +++ b/docs/source/config_file.rst @@ -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 @@ -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