Skip to content

[MRG] DOC Ensure that gen_batches passes numpydoc validation #24609

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

Jump to bottom
Merged
merged 5 commits into from
Oct 13, 2022
Merged

[MRG] DOC Ensure that gen_batches passes numpydoc validation #24609

merged 5 commits into from
Oct 13, 2022

Conversation

thatgeeman
Copy link
Contributor

Reference Issues/PRs

Addresses #21350
Ensures that sklearn.utils.gen_batches passes numpydoc validation.

What does this implement/fix? Explain your changes.

  • Modified documentation for gen_batches
  • Removed gen_batches from FUNCTION_DOCSTRING_IGNORE_LIST (sklearn/tests/test_docstrings.py)

Any other comments?

  • The docstring passed all tests in sklearn/tests/test_docstrings.py

@thomasjpfan thomasjpfan mentioned this pull request Oct 12, 2022
Closed
jeremiedbb
jeremiedbb approved these changes Oct 13, 2022
View reviewed changes
Copy link
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 for the PR @thatgeeman. LGTM.

@jeremiedbb jeremiedbb merged commit 0003ee0 into scikit-learn:main Oct 13, 2022
@thatgeeman thatgeeman deleted the doc_gen_batches branch October 13, 2022 13:21
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Oct 31, 2022
@thatgeeman @glemaitre
DOC Ensure that gen_batches passes numpydoc validation (scikit-learn#…
317da38 
…24609)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeremiedbb jeremiedbb jeremiedbb approved these changes

Assignees
No one assigned
Labels
Documentation module:utils No Changelog Needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@thatgeeman @jeremiedbb @cmarmo