diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-12-27 21:30:34 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-27 21:30:34 +0100 |
| commit | 7d2584251552283bf95893019e74dad0390dc65c (patch) | |
| tree | 7b5b8fa573a94d73b97741789a3e1fe35c7e7824 /pylint/extensions/check_docs.py | |
| parent | 691b41b3ddd3b533bce4d6a1f03ebc1e5cacf508 (diff) | |
| download | pylint-git-7d2584251552283bf95893019e74dad0390dc65c.tar.gz | |
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>
Diffstat (limited to 'pylint/extensions/check_docs.py')
| -rw-r--r-- | pylint/extensions/check_docs.py | 9 |
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, |