summaryrefslogtreecommitdiff
path: root/pylint/extensions/check_docs.py
diff options
context:
space:
mode:
Diffstat (limited to 'pylint/extensions/check_docs.py')
-rw-r--r--pylint/extensions/check_docs.py9
1 files changed, 4 insertions, 5 deletions
diff --git a/pylint/extensions/check_docs.py b/pylint/extensions/check_docs.py
index 96ea4311f..141f51298 100644
--- a/pylint/extensions/check_docs.py
+++ b/pylint/extensions/check_docs.py
@@ -9,16 +9,15 @@
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
import warnings
+from typing import TYPE_CHECKING
from pylint.extensions import docparams
+if TYPE_CHECKING:
+ from pylint.lint import PyLinter
-def register(linter):
- """Required method to auto register this checker.
- :param linter: Main interface object for Pylint plugins
- :type linter: Pylint object
- """
+def register(linter: "PyLinter") -> None:
warnings.warn(
"This plugin is deprecated, use pylint.extensions.docparams instead.",
DeprecationWarning,