Skip to content

DOC Ensures that load_wine passes numpydoc #22469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 21, 2022
Merged

DOC Ensures that load_wine passes numpydoc #22469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
25be32b
Description added for load_wine function and Source information has m…
sharmadharmpal Feb 13, 2022
6f8910c
Merge branch 'main' into DocString_21350_load_wine
jeremiedbb Mar 21, 2022
26777b5
Update _base.py
jeremiedbb Mar 21, 2022
97d1734
Update test_docstrings.py
jeremiedbb Mar 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions sklearn/datasets/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,10 @@ def load_wine(*, return_X_y=False, as_frame=False):
Features real, positive
================= ==============

The copy of UCI ML Wine Data Set dataset is downloaded and modified to fit
standard format from:
https://archive.ics.uci.edu/ml/machine-learning-databases/wine/wine.data

Read more in the :ref:`User Guide <wine_dataset>`.

Parameters
Expand Down Expand Up @@ -483,10 +487,9 @@ def load_wine(*, return_X_y=False, as_frame=False):
The full description of the dataset.

(data, target) : tuple if ``return_X_y`` is True

The copy of UCI ML Wine Data Set dataset is downloaded and modified to fit
standard format from:
https://archive.ics.uci.edu/ml/machine-learning-databases/wine/wine.data
A tuple of two ndarrays by default. The first contains a 2D array of shape
(178, 13) with each row representing one sample and each column representing
the features. The second array of shape (178,) contains the target samples.

Examples
--------
Expand Down
1 change: 0 additions & 1 deletion sklearn/tests/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
FUNCTION_DOCSTRING_IGNORE_LIST = [
"sklearn.covariance._shrunk_covariance.ledoit_wolf",
"sklearn.datasets._base.load_sample_image",
"sklearn.datasets._base.load_wine",
"sklearn.datasets._covtype.fetch_covtype",
"sklearn.datasets._kddcup99.fetch_kddcup99",
"sklearn.datasets._lfw.fetch_lfw_pairs",
Expand Down