diff options
Diffstat (limited to 'pylint/extensions/docparams.py')
| -rw-r--r-- | pylint/extensions/docparams.py | 15 |
1 files changed, 5 insertions, 10 deletions
diff --git a/pylint/extensions/docparams.py b/pylint/extensions/docparams.py index 4fadf9458..8a29a947d 100644 --- a/pylint/extensions/docparams.py +++ b/pylint/extensions/docparams.py @@ -27,7 +27,7 @@ """Pylint plugin for checking in Sphinx, Google, or Numpy style docstrings """ import re -from typing import Optional +from typing import TYPE_CHECKING, Optional import astroid from astroid import nodes @@ -39,6 +39,9 @@ from pylint.extensions._check_docs_utils import Docstring from pylint.interfaces import IAstroidChecker from pylint.utils import get_global_option +if TYPE_CHECKING: + from pylint.lint import PyLinter + class DocstringParameterChecker(BaseChecker): """Checker for Sphinx, Google, or Numpy style docstrings @@ -59,9 +62,6 @@ class DocstringParameterChecker(BaseChecker): load-plugins=pylint.extensions.docparams to the ``MASTER`` section of your ``.pylintrc``. - - :param linter: linter object - :type linter: :class:`pylint.lint.PyLinter` """ __implements__ = IAstroidChecker @@ -665,10 +665,5 @@ class DocstringParameterChecker(BaseChecker): ) -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: linter.register_checker(DocstringParameterChecker(linter)) |