DOC Ensures that sklearn.utils.validation.indexable passes numpydoc validation (#21431)

majauhar · miwojc · glemaitre · web-flow · commit 8d26900b1bd6 · 2021-10-24T11:01:08.000+02:00
Co-authored-by: miwojc &lt;miwojc@protonmail.com&gt;
Co-authored-by: Guillaume Lemaitre &lt;g.lemaitre58@gmail.com&gt;
diff --git a/maint_tools/test_docstrings.py b/maint_tools/test_docstrings.py
@@ -241,7 +241,6 @@
     "sklearn.utils.validation.check_random_state",
     "sklearn.utils.validation.column_or_1d",
     "sklearn.utils.validation.has_fit_parameter",
-    "sklearn.utils.validation.indexable",
 ]
 FUNCTION_DOCSTRING_IGNORE_LIST = set(FUNCTION_DOCSTRING_IGNORE_LIST)
 
diff --git a/sklearn/utils/validation.py b/sklearn/utils/validation.py
@@ -365,7 +365,14 @@ def indexable(*iterables):
     ----------
     *iterables : {lists, dataframes, ndarrays, sparse matrices}
         List of objects to ensure sliceability.
+
+    Returns
+    -------
+    result : list of {ndarray, sparse matrix, dataframe} or None
+        Returns a list containing indexable arrays (i.e. NumPy array,
+        sparse matrix, or dataframe) or `None`.
     """
+
     result = [_make_indexable(X) for X in iterables]
     check_consistent_length(*result)
     return result

Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,6 @@`
`241`	`241`	`"sklearn.utils.validation.check_random_state",`
`242`	`242`	`"sklearn.utils.validation.column_or_1d",`
`243`	`243`	`"sklearn.utils.validation.has_fit_parameter",`
`244`		`- "sklearn.utils.validation.indexable",`
`245`	`244`	`]`
`246`	`245`	`FUNCTION_DOCSTRING_IGNORE_LIST = set(FUNCTION_DOCSTRING_IGNORE_LIST)`
`247`	`246`