Skip to content

DOC corrected docstring on fetch_california_housing#22882

Merged
jeremiedbb merged 3 commits intoscikit-learn:mainfrom
DeaMariaLeon:docstring2
Mar 21, 2022
Merged

DOC corrected docstring on fetch_california_housing#22882
jeremiedbb merged 3 commits intoscikit-learn:mainfrom
DeaMariaLeon:docstring2

Conversation

@DeaMariaLeon
Copy link
Copy Markdown
Member

Reference Issues/PRs
Addresses meta issue #21350

What does this implement/fix? Explain your changes.
Corrected docstring on california_housing

Any other comments?
#pariswimlds

@jeremiedbb jeremiedbb added No Changelog Needed Quick Review For PRs that are quick to review labels Mar 18, 2022
Returns
-------
dataset : :class:`~sklearn.utils.Bunch`
dataset : Class:`~sklearn.utils.Bunch`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
dataset : Class:`~sklearn.utils.Bunch`
dataset : :class:`~sklearn.utils.Bunch`

This is the notation for a reference in sphinx and should not be modified.

Merge remote-tracking branch 'upstream/main' into docstring2
Copy link
Copy Markdown
Member

@ArturoAmorQ ArturoAmorQ left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @DeaMariaLeon!

@DeaMariaLeon
Copy link
Copy Markdown
Member Author

LGTM, thanks @DeaMariaLeon!

Thanks to you!

Copy link
Copy Markdown
Member

@jeremiedbb jeremiedbb left a comment

Choose a reason for hiding this comment

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

Thanks @DeaMariaLeon

@jeremiedbb jeremiedbb merged commit 3dda318 into scikit-learn:main Mar 21, 2022
@DeaMariaLeon DeaMariaLeon deleted the docstring2 branch March 21, 2022 18:47
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Apr 6, 2022
@thomasjpfan thomasjpfan changed the title DOC corrected docstring on california_housing DOC corrected docstring on fetch_california_housing Jul 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants