Skip to content

DOC Ensures that load_iris passes numpydoc validation#21760

Merged
thomasjpfan merged 6 commits intoscikit-learn:mainfrom
ArturoAmorQ:doc_iris
Dec 1, 2021
Merged

DOC Ensures that load_iris passes numpydoc validation#21760
thomasjpfan merged 6 commits intoscikit-learn:mainfrom
ArturoAmorQ:doc_iris

Conversation

@ArturoAmorQ
Copy link
Copy Markdown
Member

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

This PR ensure that sklearn.datasets._base.load_iris function docstrings passes all numpydoc validation checks.

  • sklearn.datasets._base.load_iris removed from scikit-learn/maint_tools/test_docstrings.py
  • Added description to returned values ('data' and 'target').

Any other comments?

Copy link
Copy Markdown
Member

@jjerphan jjerphan left a comment

Choose a reason for hiding this comment

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

LGTM once comments are addressed. Thank you, @ArturoAmorQ.

Copy link
Copy Markdown
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

LGTM

@thomasjpfan thomasjpfan merged commit f67a179 into scikit-learn:main Dec 1, 2021
thomasjpfan pushed a commit to thomasjpfan/scikit-learn that referenced this pull request Dec 1, 2021
Copy link
Copy Markdown

@RobsA1 RobsA1 left a comment

Choose a reason for hiding this comment

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

glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Dec 24, 2021
glemaitre pushed a commit that referenced this pull request Dec 25, 2021
Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>
@ArturoAmorQ ArturoAmorQ deleted the doc_iris branch March 30, 2022 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants