DOC Ensures that check_is_fitted passes numpydoc validation (#24454)

yuanx749 · web-flow · commit b850a9417d47 · 2022-09-16T17:03:45.000+02:00
diff --git a/sklearn/tests/test_docstrings.py b/sklearn/tests/test_docstrings.py
@@ -49,7 +49,6 @@
     "sklearn.utils.sparsefuncs.incr_mean_variance_axis",
     "sklearn.utils.sparsefuncs.inplace_swap_row_csc",
     "sklearn.utils.sparsefuncs.inplace_swap_row_csr",
-    "sklearn.utils.validation.check_is_fitted",
 ]
 FUNCTION_DOCSTRING_IGNORE_LIST = set(FUNCTION_DOCSTRING_IGNORE_LIST)
 
diff --git a/sklearn/utils/validation.py b/sklearn/utils/validation.py
@@ -1294,7 +1294,7 @@ def check_is_fitted(estimator, attributes=None, *, msg=None, all_or_any=all):
     Parameters
     ----------
     estimator : estimator instance
-        estimator instance for which the check is performed.
+        Estimator instance for which the check is performed.
 
     attributes : str, list or tuple of str, default=None
         Attribute name(s) given as string or a list/tuple of strings
@@ -1317,12 +1317,11 @@ def check_is_fitted(estimator, attributes=None, *, msg=None, all_or_any=all):
     all_or_any : callable, {all, any}, default=all
         Specify whether all or any of the given attributes must exist.
 
-    Returns
-    -------
-    None
-
     Raises
     ------
+    TypeError
+        If the estimator is a class or not an estimator instance
+
     NotFittedError
         If the attributes are not found.
     """

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,6 @@`
`49`	`49`	`"sklearn.utils.sparsefuncs.incr_mean_variance_axis",`
`50`	`50`	`"sklearn.utils.sparsefuncs.inplace_swap_row_csc",`
`51`	`51`	`"sklearn.utils.sparsefuncs.inplace_swap_row_csr",`
`52`		`- "sklearn.utils.validation.check_is_fitted",`
`53`	`52`	`]`
`54`	`53`	`FUNCTION_DOCSTRING_IGNORE_LIST = set(FUNCTION_DOCSTRING_IGNORE_LIST)`
`55`	`54`