Remove the check_docs extension and remove any references to it (#5730)

Author: DanielNoord

ChangeLog

@@ -15,6 +15,11 @@ Release date: TBA
 
   Closes #5648
 
+* Removed the deprecated ``check_docs`` extension. You can use the ``docparams`` checker
+  to get the checks previously included in ``check_docs``.
+
+  Closes #5322
+
 * Added several checkers to deal with unicode security issues
   (see `Trojan Sources <https://trojansource.codes/>`_ and
   `PEP 672 <https://www.python.org/dev/peps/pep-0672/>`_ for details) that also

doc/exts/pylint_extensions.py

@@ -14,13 +14,6 @@
 from pylint.lint import PyLinter
 from pylint.utils import get_rst_title
 
-# Some modules have been renamed and deprecated under their old names.
-# Skip documenting these modules since:
-# 1) They are deprecated, why document them moving forward?
-# 2) We can't load the deprecated module and the newly renamed module at the
-# same time without getting naming conflicts
-DEPRECATED_MODULES = ["check_docs"]  # ==> docparams
-
 
 def builder_inited(app):
     """Output full documentation in ReST format for all extension modules"""
@@ -34,7 +27,7 @@ def builder_inited(app):
     doc_files = {}
     for filename in os.listdir(ext_path):
         name, ext = os.path.splitext(filename)
-        if name[0] == "_" or name in DEPRECATED_MODULES:
+        if name[0] == "_":
             continue
         if ext == ".py":
             modules.append(f"pylint.extensions.{name}")

doc/whatsnew/2.13.rst

@@ -59,6 +59,11 @@ New checkers
 Removed checkers
 ================
 
+* Removed the deprecated ``check_docs`` extension. You can use the ``docparams`` checker
+  to get the checks previously included in ``check_docs``.
+
+  Closes #5322
+
 Extensions
 ==========
 

pylint/extensions/check_docs.py

@@ -456,13 +456,7 @@ def cb_verbose_mode(self, *args, **kwargs):
     def cb_enable_all_extensions(self, option_name: str, value: None) -> None:
         """Callback to load and enable all available extensions"""
         for filename in os.listdir(os.path.dirname(extensions.__file__)):
-            # pylint: disable=fixme
-            # TODO: Remove the check for deprecated check_docs after the extension has been removed
-            if (
-                filename.endswith(".py")
-                and not filename.startswith("_")
-                and not filename.startswith("check_docs")
-            ):
+            if filename.endswith(".py") and not filename.startswith("_"):
                 extension_name = f"pylint.extensions.{filename[:-3]}"
                 if extension_name not in self._plugins:
                     self._plugins.append(extension_name)

pylint/lint/run.py

@@ -12,9 +12,7 @@
 # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
 
-"""Unit tests for the pylint checkers in :mod:`pylint.extensions.check_docs`,
-in particular the parameter documentation checker `DocstringChecker`
-"""
+"""Unit tests for utils functions in :mod:`pylint.extensions._check_docs_utils`."""
 import astroid
 import pytest
 

tests/extensions/test_check_docs_utils.py

@@ -1258,13 +1258,7 @@ def test_enable_all_extensions() -> None:
         # Record all extensions
         plugins = []
         for filename in os.listdir(os.path.dirname(extensions.__file__)):
-            # pylint: disable=fixme
-            # TODO: Remove the check for deprecated check_docs after the extension has been removed
-            if (
-                filename.endswith(".py")
-                and not filename.startswith("_")
-                and not filename.startswith("check_docs")
-            ):
+            if filename.endswith(".py") and not filename.startswith("_"):
                 plugins.append(f"pylint.extensions.{filename[:-3]}")
 
         # Check if they are loaded