DOC Ensures that available_if passes numpydoc validation (#24586)

irene000 · thomasjpfan · web-flow · commit 798aeebdee1e · 2022-10-06T11:48:21.000-04:00
Co-authored-by: Thomas J. Fan &lt;thomasjpfan@gmail.com&gt;
diff --git a/sklearn/tests/test_docstrings.py b/sklearn/tests/test_docstrings.py
@@ -25,7 +25,6 @@
     "sklearn.utils.fixes.threadpool_limits",
     "sklearn.utils.gen_batches",
     "sklearn.utils.gen_even_slices",
-    "sklearn.utils.metaestimators.available_if",
     "sklearn.utils.metaestimators.if_delegate_has_method",
 ]
 FUNCTION_DOCSTRING_IGNORE_LIST = set(FUNCTION_DOCSTRING_IGNORE_LIST)
diff --git a/sklearn/utils/metaestimators.py b/sklearn/utils/metaestimators.py
@@ -141,7 +141,7 @@ def out(*args, **kwargs):
 
 
 def available_if(check):
-    """An attribute that is available only if check returns a truthy value
+    """An attribute that is available only if check returns a truthy value.
 
     Parameters
     ----------
@@ -150,6 +150,12 @@ def available_if(check):
         a truthy value if the attribute is available, and either return False
         or raise an AttributeError if not available.
 
+    Returns
+    -------
+    callable
+        Callable makes the decorated method available if `check` returns
+        a truthy value, otherwise the decorated method is unavailable.
+
     Examples
     --------
     >>> from sklearn.utils.metaestimators import available_if

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,6 @@`
`25`	`25`	`"sklearn.utils.fixes.threadpool_limits",`
`26`	`26`	`"sklearn.utils.gen_batches",`
`27`	`27`	`"sklearn.utils.gen_even_slices",`
`28`		`- "sklearn.utils.metaestimators.available_if",`
`29`	`28`	`"sklearn.utils.metaestimators.if_delegate_has_method",`
`30`	`29`	`]`
`31`	`30`	`FUNCTION_DOCSTRING_IGNORE_LIST = set(FUNCTION_DOCSTRING_IGNORE_LIST)`