Improve searchability for module level type ignore errors (#14342)

python · Dec 25, 2022 · c246a52 · c246a52
1 parent 31b0413
commit c246a52
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/source/common_issues.rst b/docs/source/common_issues.rst
@@ -188,6 +188,8 @@ Ignoring a whole file
 
 A ``# type: ignore`` comment at the top of a module (before any statements,
 including imports or docstrings) has the effect of ignoring the entire contents of the module.
+This behaviour can be surprising and result in
+"Module ... has no attribute ... [attr-defined]" errors.
 
 To only ignore errors, use a top-level ``# mypy: ignore-errors`` comment instead.
 To only ignore errors with a specific error code, use a top-level