Clarify documentation typing extension

nelfin · Jun 10, 2021 · 9767d14 · 9767d14
1 parent 2a186f4
commit 9767d14
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -135,6 +135,10 @@ modules are added.
 
 * New checker ``await-outside-async``. Emitted when await is used outside an async function.
 
+* Clarify documentation for ``typing`` extension.
+
+  Closes #4545
+
 
 What's New in Pylint 2.8.3?
 ===========================

diff --git a/pylint/extensions/typing.py b/pylint/extensions/typing.py
@@ -124,10 +124,10 @@ class TypingChecker(BaseChecker):
                 "type": "yn",
                 "metavar": "<y_or_n>",
                 "help": (
-                    "Set to ``no`` if the app / libary does NOT need to "
-                    "support runtime introspection of type "
-                    "annotations. Only applies to Python version "
-                    "3.7 - 3.9"
+                    "Set to ``no`` if the app / library does NOT need to "
+                    "support runtime introspection of type annotations. "
+                    "Only change it if you understand what that means. "
+                    "Applies to Python version 3.7 - 3.9"
                 ),
             },
         ),