Skip to content

Commit ea07ddb

Browse files
committed
Warn about --follow-untyped-imports
1 parent 5082a22 commit ea07ddb

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

docs/source/command_line.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,11 @@ imports.
168168

169169
.. option:: --follow-untyped-imports
170170

171-
This flag makes mypy analyze imports without stubs or a py.typed marker.
171+
This flag makes mypy analyze imports even if missing a py.typed marker or stubs.
172+
173+
Note that analyzing all unannotated modules might result in issues
174+
when analyzing code not designed to be type checked and may significantly
175+
increase how long mypy takes to run.
172176

173177
.. option:: --follow-imports {normal,silent,skip,error}
174178

docs/source/config_file.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -320,12 +320,15 @@ section of the command line docs.
320320
:type: boolean
321321
:default: False
322322

323-
Typechecks imports from modules that do not have stubs or a py.typed marker.
323+
Makes mypy analyze imports even if missing a py.typed marker or stubs.
324+
325+
Note that analyzing all unannotated modules might result in issues
326+
when analyzing code not designed to be type checked and may significantly
327+
increase how long mypy takes to run.
324328

325329
If this option is used in a per-module section, the module name should
326330
match the name of the *imported* module, not the module containing the
327-
import statement. Note that scanning all unannotated modules might
328-
significantly increase the runtime of your mypy calls.
331+
import statement
329332

330333
.. confval:: follow_imports
331334

0 commit comments

Comments
 (0)