Skip to content

DOC Ensures that NearestNeighbors passes numpydoc validation#20446

Merged
glemaitre merged 3 commits intoscikit-learn:mainfrom
jmloyola:fix_numpydoc_nearestneighbors
Jul 6, 2021
Merged

DOC Ensures that NearestNeighbors passes numpydoc validation#20446
glemaitre merged 3 commits intoscikit-learn:mainfrom
jmloyola:fix_numpydoc_nearestneighbors

Conversation

@jmloyola
Copy link
Copy Markdown
Member

@jmloyola jmloyola commented Jul 2, 2021

Reference Issues/PRs

Addresses #20308

What does this implement/fix? Explain your changes.

This PR ensures NearestNeighbors is compatible with numpydoc.

  • Remove NearestNeighbors from DOCSTRING_IGNORE_LIST.
  • Verify all tests passing.

Any other comments?

#DataUmbrella Sprint

Copy link
Copy Markdown
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

LGTM. I only pushed a small change regarding some return line to be consistent with other part in the code.

@glemaitre glemaitre merged commit ca406e2 into scikit-learn:main Jul 6, 2021
@glemaitre
Copy link
Copy Markdown
Member

Thanks @jmloyola

@jmloyola jmloyola deleted the fix_numpydoc_nearestneighbors branch July 6, 2021 11:58
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
…learn#20446)

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants