Skip to content

DOC Ensures that available_if passes numpydoc validation#24586

Merged
thomasjpfan merged 4 commits intoscikit-learn:mainfrom
irene000:validate_docstrings_available_if
Oct 6, 2022
Merged

DOC Ensures that available_if passes numpydoc validation#24586
thomasjpfan merged 4 commits intoscikit-learn:mainfrom
irene000:validate_docstrings_available_if

Conversation

@irene000
Copy link
Copy Markdown
Contributor

@irene000 irene000 commented Oct 5, 2022

Reference Issues/PRs

Addresses #21350
Ensures sklearn.utils.metaestimators.available_if passes numpydoc validation

What does this implement/fix? Explain your changes.

Removed sklearn.utils.metaestimators.available_if from FUNCTION_DOCSTRING_IGNORE_LIST
Added Returns section
Fixed Summary to end with a period

Any other comments?

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.

Thank you for the PR @irene000 !

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.

Thank you for the update! LGTM

@thomasjpfan thomasjpfan changed the title DOC Ensures that sklearn.utils.metaestimators.available_if passes numpydoc validation DOC Ensures that available_if passes numpydoc validation Oct 6, 2022
@thomasjpfan thomasjpfan merged commit 798aeeb into scikit-learn:main Oct 6, 2022
thomasjpfan added a commit to thomasjpfan/scikit-learn that referenced this pull request Oct 9, 2022
…n#24586)

Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Oct 31, 2022
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.

3 participants