third_party.pylibs.pylint.src/pylint/extensions/check_docs.py

19 lines
586 B
Python

# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/master/COPYING
import warnings
from pylint.extensions import docparams
def register(linter):
"""Required method to auto register this checker.
:param linter: Main interface object for Pylint plugins
:type linter: Pylint object
"""
warnings.warn("This plugin is deprecated, use pylint.extensions.docparams instead.",
DeprecationWarning)
linter.register_checker(docparams.DocstringParameterChecker(linter))