check_docs.py 997 B

1234567891011121314151617181920212223242526
  1. # Copyright (c) 2014-2015 Bruno Daniel <bruno.daniel@blue-yonder.com>
  2. # Copyright (c) 2015-2016, 2018, 2020 Claudiu Popa <pcmanticore@gmail.com>
  3. # Copyright (c) 2016 Ashley Whetter <ashley@awhetter.co.uk>
  4. # Copyright (c) 2020 hippo91 <guillaume.peillex@gmail.com>
  5. # Copyright (c) 2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
  6. # Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
  7. # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
  8. # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
  9. import warnings
  10. from pylint.extensions import docparams
  11. def register(linter):
  12. """Required method to auto register this checker.
  13. :param linter: Main interface object for Pylint plugins
  14. :type linter: Pylint object
  15. """
  16. warnings.warn(
  17. "This plugin is deprecated, use pylint.extensions.docparams instead.",
  18. DeprecationWarning,
  19. )
  20. linter.register_checker(docparams.DocstringParameterChecker(linter))