Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 5f604b7

Browse files
authored
DOC Ensures that fetch_lfw_people passes numpydoc validation (#24161)
Co-authored-by: Franck Charras <[email protected]>
1 parent fc656c2 commit 5f604b7

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

sklearn/datasets/_lfw.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ def fetch_lfw_people(
278278
slice_ : tuple of slice, default=(slice(70, 195), slice(78, 172))
279279
Provide a custom 2D slice (height, width) to extract the
280280
'interesting' part of the jpeg files and avoid use statistical
281-
correlation from the background
281+
correlation from the background.
282282
283283
download_if_missing : bool, default=True
284284
If False, raise a IOError if the data is not locally available
@@ -315,6 +315,10 @@ def fetch_lfw_people(
315315
Description of the Labeled Faces in the Wild (LFW) dataset.
316316
317317
(data, target) : tuple if ``return_X_y`` is True
318+
A tuple of two ndarray. The first containing a 2D array of
319+
shape (n_samples, n_features) with each row representing one
320+
sample and each column representing the features. The second
321+
ndarray of shape (n_samples,) containing the target samples.
318322
319323
.. versionadded:: 0.20
320324
"""

sklearn/tests/test_docstrings.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
numpydoc_validation = pytest.importorskip("numpydoc.validate")
1313

1414
FUNCTION_DOCSTRING_IGNORE_LIST = [
15-
"sklearn.datasets._lfw.fetch_lfw_people",
1615
"sklearn.datasets._svmlight_format_io.load_svmlight_file",
1716
"sklearn.datasets._svmlight_format_io.load_svmlight_files",
1817
"sklearn.decomposition._dict_learning.dict_learning",

0 commit comments

Comments
 (0)