Add typing and uniformize the checker registering in Pylinter (#5558)

Remove verbose docstring in code, keep them in example and doc

Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>

1 files changed, 5 insertions, 3 deletions

diff --git a/pylint/checkers/misc.py b/pylint/checkers/misc.py
index 8090679e8..4eb52336d 100644
--- a/pylint/checkers/misc.py
+++ b/pylint/checkers/misc.py
@@ -29,7 +29,7 @@
 
 import re
 import tokenize
-from typing import List, Optional
+from typing import TYPE_CHECKING, List, Optional
 
 from astroid import nodes
 
@@ -38,6 +38,9 @@ from pylint.interfaces import IRawChecker, ITokenChecker
 from pylint.typing import ManagedMessage
 from pylint.utils.pragma_parser import OPTION_PO, PragmaParserError, parse_pragma
 
+if TYPE_CHECKING:
+    from pylint.lint import PyLinter
+
 
 class ByIdManagedMessagesChecker(BaseChecker):
 
@@ -195,7 +198,6 @@ class EncodingChecker(BaseChecker):
                 )
 
 
-def register(linter):
-    """required method to auto register this checker"""
+def register(linter: "PyLinter") -> None:
     linter.register_checker(EncodingChecker(linter))
     linter.register_checker(ByIdManagedMessagesChecker(linter))