Skip to content

[MRG] DOC: fix document that fetch_20newsgroups #12783

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 8 commits into from
Dec 23, 2018
Merged

[MRG] DOC: fix document that fetch_20newsgroups #12783

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
14bae44
[WIP] DOC: fix document that fetch_20newsgroups
Dec 14, 2018
d4b7c02
improve docstring
Dec 14, 2018
aaeaebf
fix docs
eamanu Dec 16, 2018
0f6dac5
fix whitelines on bullets
eamanu Dec 16, 2018
580b3fc
fix doc
eamanu Dec 16, 2018
082fdc6
fix docs
eamanu Dec 16, 2018
0275d02
fix doc
eamanu Dec 17, 2018
22f259f
correction
qinhanmin2014 Dec 23, 2018
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
23 changes: 13 additions & 10 deletions sklearn/datasets/twenty_newsgroups.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,11 +216,13 @@ def fetch_20newsgroups(data_home=None, subset='train', categories=None,

Returns
-------
bunch : Bunch object
bunch.data: list, length [n_samples]
bunch.target: array, shape [n_samples]
bunch.filenames: list, length [n_classes]
bunch.DESCR: a description of the dataset.
bunch : Bunch object with the following attribute:
- bunch.data: list, length [n_samples]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you may not need these newlines in between these items.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remove it.

- bunch.target: array, shape [n_samples]
- bunch.filenames: list, length [n_samples]
- bunch.DESCR: a description of the dataset.
- bunch.target_names: a list of categories of the returned data,
length [n_classes]. This depends on the `categories` parameter.
"""

data_home = get_data_home(data_home=data_home)
Expand Down Expand Up @@ -369,11 +371,12 @@ def fetch_20newsgroups_vectorized(subset="train", remove=(), data_home=None,

Returns
-------
bunch : Bunch object
bunch.data: sparse matrix, shape [n_samples, n_features]
bunch.target: array, shape [n_samples]
bunch.target_names: list, length [n_classes]
bunch.DESCR: a description of the dataset.
bunch : Bunch object with the following attribute:
- bunch.data: sparse matrix, shape [n_samples, n_features]
- bunch.target: array, shape [n_samples]
- bunch.target_names: a list of categories of the returned data,
length [n_classes].
- bunch.DESCR: a description of the dataset.

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

Expand Down