FIX docstring of sklearn.datasets._svmlight_format_io.load_svmlight_file to pass docstring test

fcharras · fcharras · commit 4f22edfb4240 · 2022-08-10T16:19:21.000+02:00
diff --git a/sklearn/datasets/_svmlight_format_io.py b/sklearn/datasets/_svmlight_format_io.py
@@ -53,7 +53,7 @@ def load_svmlight_file(
     offset=0,
     length=-1,
 ):
-    """Load datasets in the svmlight / libsvm format into sparse CSR matrix
+    """Load datasets in the svmlight / libsvm format into sparse CSR matrix.
 
     This format is a text-based format, with one sample per line. It does
     not store zero valued features hence is suitable for sparse dataset.
@@ -106,7 +106,7 @@ def load_svmlight_file(
 
     multilabel : bool, default=False
         Samples may have several labels each (see
-        https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multilabel.html)
+        https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multilabel.html).
 
     zero_based : bool or "auto", default="auto"
         Whether column indices in f are zero-based (True) or one-based
@@ -135,12 +135,14 @@ def load_svmlight_file(
     Returns
     -------
     X : scipy.sparse matrix of shape (n_samples, n_features)
+        The data matrix.
 
-    y : ndarray of shape (n_samples,), or, in the multilabel a list of
-        tuples of length n_samples.
+    y : ndarray of shape (n_samples,), or a list of tuples of length n_samples
+        The target. The output type depends on the value of the parameter
+        ``multilabel``.
 
     query_id : array of shape (n_samples,)
-       query_id for each sample. Only returned when query_id is set to
+       The query_id for each sample. Only returned when query_id is set to
        True.
 
     See Also
diff --git a/sklearn/tests/test_docstrings.py b/sklearn/tests/test_docstrings.py
@@ -14,7 +14,6 @@
 FUNCTION_DOCSTRING_IGNORE_LIST = [
     "sklearn.datasets._lfw.fetch_lfw_people",
     "sklearn.datasets._species_distributions.fetch_species_distributions",
-    "sklearn.datasets._svmlight_format_io.load_svmlight_file",
     "sklearn.datasets._svmlight_format_io.load_svmlight_files",
     "sklearn.decomposition._dict_learning.dict_learning",
     "sklearn.decomposition._dict_learning.dict_learning_online",
