Skip to content

[MRG] DOC Ensure that gen_even_slices passes numpydoc validation #24608

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 2 commits into from
Oct 10, 2022
Merged

[MRG] DOC Ensure that gen_even_slices passes numpydoc validation #24608

merged 2 commits into from
Oct 10, 2022

Conversation

thatgeeman
Copy link
Contributor

Reference Issues/PRs

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

What does this implement/fix? Explain your changes.

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

Any other comments?

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

@glemaitre glemaitre self-requested a review October 10, 2022 13:36
@glemaitre glemaitre merged commit 0ee0189 into scikit-learn:main Oct 10, 2022
@glemaitre
Copy link
Member

LGTM thanks @thatgeeman

@thatgeeman thatgeeman deleted the doc_val branch October 10, 2022 21:05
@thomasjpfan thomasjpfan mentioned this pull request Oct 12, 2022
Closed
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Oct 31, 2022
@thatgeeman @glemaitre
DOC Ensure that gen_even_slices passes numpydoc validation (scikit-le…
c701ad4 
…arn#24608)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glemaitre glemaitre Awaiting requested review from glemaitre

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 @glemaitre @cmarmo