Skip to content

DOC Ensures that K/RadiusNeighborsRegressor passes numpydoc validation #20378

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 16 commits into from
Jul 20, 2021
Merged

DOC Ensures that K/RadiusNeighborsRegressor passes numpydoc validation #20378

merged 16 commits into from
Jul 20, 2021

Conversation

trhughes
Copy link

@trhughes trhughes commented Jun 26, 2021 •
edited
Loading

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Changed order of sections in KneighborsRegressor class at sklearn/neighbors/_regression.py.

Any other comments?

This is part of the following issue: "Ensure that docstrings pass numpydoc validation" #20308

@trhughes trhughes marked this pull request as draft June 26, 2021 18:18
@reshamas
Copy link
Member

#DataUmbrella sprint

@thomasjpfan thomasjpfan marked this pull request as ready for review June 26, 2021 19:55
@thomasjpfan thomasjpfan marked this pull request as draft June 26, 2021 19:55
@thomasjpfan
Copy link
Member

Feel free to make this "ready for review" when you are ready.

@trhughes trhughes changed the title First fix to KneighborsRegressor docstring DOC Ensures that KNeighborsRegressor passes numpydoc validation Jun 26, 2021
rth
rth approved these changes Jun 27, 2021
View reviewed changes
Copy link
Member

@rth rth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM, thanks @trhughes ! Did you keep it in Draft mode because you wanted to add more things?

thomasjpfan
thomasjpfan reviewed Jun 27, 2021
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 @trhughes !

@thomasjpfan thomasjpfan mentioned this pull request Jun 27, 2021
Closed
@trhughes trhughes marked this pull request as ready for review July 9, 2021 04:26
thomasjpfan
thomasjpfan reviewed Jul 10, 2021
View reviewed changes
cmaureir
cmaureir reviewed Jul 10, 2021
View reviewed changes
@tomasrhughes @cmaureir
Update sklearn/base.py
41587d5 
Co-authored-by: Cristián Maureira-Fredes <cmaureir@users.noreply.github.com>
@glemaitre glemaitre self-assigned this Jul 20, 2021
@glemaitre glemaitre changed the title DOC Ensures that KNeighborsRegressor passes numpydoc validation DOC Ensures that K/RadiusNeighborsRegressor passes numpydoc validation Jul 20, 2021
@glemaitre
Copy link
Member

I solve the issue normally. Let see if the CIs are happy.

@glemaitre glemaitre merged commit 2480f5a into scikit-learn:main Jul 20, 2021
@glemaitre
Copy link
Member

Thanks @trhughes

samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
@tomasrhughes @thomasjpfan
@cmaureir @glemaitre @samronsin
DOC Ensures that K/RadiusNeighborsRegressor passes numpydoc validation (
6a74e18 
scikit-learn#20378)

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

@cmaureir cmaureir cmaureir left review comments

@thomasjpfan thomasjpfan thomasjpfan left review comments

@rth rth rth approved these changes

Assignees

@glemaitre glemaitre

Labels
Documentation module:neighbors
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@trhughes @reshamas @thomasjpfan @glemaitre @cmaureir @rth @tomasrhughes