8000 DOC Ensures that if_delegate_has_method passes numpydoc validation by michpara · Pull Request #24633 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Ensures that if_delegate_has_method passes numpydoc validation #24633

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 6 commits into from
Oct 13, 2022
Merged

DOC Ensures that if_delegate_has_method passes numpydoc validation #24633

merged 6 commits into from
Oct 13, 2022

Conversation

michpara
Copy link
Contributor
@michpara michpara commented Oct 11, 2022 •
edited by glemaitre
Loading

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Ensure sklearn.utils.metaestimators.if_delegate_has_method passes numpydoc validation

  • GL03: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
  • GL09: Deprecation warning should precede extended summary
  • SS03: Summary does not end with a period
  • RT01: No Returns section found

Any other comments?

@michpara michpara marked this pull request as ready for review October 11, 2022 02:03
@michpara michpara marked this pull request as draft October 11, 2022 02:15
@michpara
Copy link
Contributor Author

@thomasjpfan I was wondering if you had any suggestions for what can be placed in the Returns section of the docs. I'm not 100% sure I understand what if_delegate_has_method returns.

@michpara michpara marked this pull request as ready for review October 11, 2022 02:35
thomasjpfan
thomasjpfan reviewed Oct 11, 2022
View reviewed changes
Copy link
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!

@thomasjpfan thomasjpfan mentioned this pull request Oct 12, 2022
Closed
@glemaitre glemaitre merged commit 0c8820b into scikit-learn:main Oct 13, 2022
@glemaitre
Copy link
Member

Thanks @michpara

@michpara michpara deleted the doc_val_if_delegate_has_method branch October 13, 2022 23:00
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Oct 31, 2022
@michpara @glemaitre @thomasjpfan
DOC Ensures that if_delegate_has_method passes numpydoc validation (s…
64937d2 
…cikit-learn#24633)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thomasjpfan thomasjpfan thomasjpfan left review comments

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
@michpara @glemaitre @thomasjpfan
0