Warn about --follow-untyped-imports

python · Dec 5, 2024 · ea07ddb · ea07ddb
1 parent 5082a22
commit ea07ddb
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/docs/source/command_line.rst b/docs/source/command_line.rst
@@ -168,7 +168,11 @@ imports.
 
 .. option:: --follow-untyped-imports
 
-    This flag makes mypy analyze imports without stubs or a py.typed marker.
+    This flag makes mypy analyze imports even if missing a py.typed marker or stubs.
+
+    Note that analyzing all unannotated modules might result in issues
+    when analyzing code not designed to be type checked and may significantly
+    increase how long mypy takes to run.
 
 .. option:: --follow-imports {normal,silent,skip,error}
 

diff --git a/docs/source/config_file.rst b/docs/source/config_file.rst
@@ -320,12 +320,15 @@ section of the command line docs.
     :type: boolean
     :default: False
 
-    Typechecks imports from modules that do not have stubs or a py.typed marker.
+    Makes mypy analyze imports even if missing a py.typed marker or stubs.
+
+    Note that analyzing all unannotated modules might result in issues
+    when analyzing code not designed to be type checked and may significantly
+    increase how long mypy takes to run.
 
     If this option is used in a per-module section, the module name should
     match the name of the *imported* module, not the module containing the
-    import statement. Note that scanning all unannotated modules might
-    significantly increase the runtime of your mypy calls.
+    import statement
 
 .. confval:: follow_imports