Skip to content

Commit 9423e31

Browse files
committed
Add a check_docs file, that registers into docparams, for maintaining backward compatibility.
1 parent 1dd66a7 commit 9423e31

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

pylint/extensions/check_docs.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
2+
# For details: https://github.com/PyCQA/pylint/blob/master/COPYING
3+
4+
import warnings
5+
6+
from pylint.extensions import docparams
7+
8+
9+
def register(linter):
10+
"""Required method to auto register this checker.
11+
12+
:param linter: Main interface object for Pylint plugins
13+
:type linter: Pylint object
14+
"""
15+
warnings.warn("This plugin is deprecated, use pylint.extensions.docparams instead.",
16+
DeprecationWarning)
17+
linter.register_checker(docparams.DocstringParameterChecker(linter))
18+

0 commit comments

Comments
 (0)