Skip to content

DOC Ensures that make_hastie_10_2 passes numpydoc validation#22333

Merged
thomasjpfan merged 1 commit intoscikit-learn:mainfrom
Dev514:make_hastie_10_2
Jan 29, 2022
Merged

DOC Ensures that make_hastie_10_2 passes numpydoc validation#22333
thomasjpfan merged 1 commit intoscikit-learn:mainfrom
Dev514:make_hastie_10_2

Conversation

@Dev514
Copy link
Copy Markdown
Contributor

@Dev514 Dev514 commented Jan 29, 2022 •
edited
Loading

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

This PR fixes the following error that was appearing for numpydoc validation for sklearn.datasets._samples_generator.make_hastie_10_2

  • GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, See Also, References
  • SS05: Summary must start with infinitive verb, not third person (e.g. use "Generate" instead of "Generates")
  • SS06: Summary should fit in a single line

Any other comments?

thomasjpfan
thomasjpfan approved these changes Jan 29, 2022
View reviewed changes
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.

Thanks for the PR @Dev514 ! LGTM

@thomasjpfan thomasjpfan merged commit 46d9143 into scikit-learn:main Jan 29, 2022
@reshamas
Copy link
Copy Markdown
Member

reshamas commented Jan 30, 2022

@thomasjpfan
Perhaps the description of this PR should say "\References #xxxxx" instead of "\Fixes #xxxxx"

@thomasjpfan
Copy link
Copy Markdown
Member

thomasjpfan commented Jan 30, 2022

Yea, I didn't see it before merging. I reopened the original issue.

@Dev514
Copy link
Copy Markdown
Contributor Author

Dev514 commented Jan 31, 2022

@thomasjpfan Is there anything that needs to be changed in this PR?.

@thomasjpfan thomasjpfan mentioned this pull request Feb 9, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thomasjpfan thomasjpfan thomasjpfan approved these changes

Assignees

No one assigned

Labels

Documentation module:datasets No Changelog Needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Dev514 @reshamas @thomasjpfan