Skip to content

DOC Improve neighbors documentation#16923

Merged
thomasjpfan merged 4 commits intoscikit-learn:masterfrom
haochunchang:fix_neighbors_document
Apr 17, 2020
Merged

DOC Improve neighbors documentation#16923
thomasjpfan merged 4 commits intoscikit-learn:masterfrom
haochunchang:fix_neighbors_document

Conversation

@haochunchang
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Fixes a todo in #3846

What does this implement/fix? Explain your changes.

As mentioned by steinfurt, they all have at least on examples.
So I fix some format issues rendered in html to make the documentation more consistent.

Besides, I make 4 methods of BinaryTree private by adding underscore to prevent them from showing in the documentation. I think this change is more considerable.

Any other comments?

This is my first contribution. Any advice is appreciated!

* Add import to Example in DistanceMetric

* Make "Only available to novelty..." bold in LocalFactorOutlier
* Make 4 methods private

* Fix class signatures
@haochunchang haochunchang changed the title Fix neighbors document DOC Improve neighbors documentation Apr 14, 2020
@haochunchang haochunchang changed the title DOC Improve neighbors documentation [MRG] DOC Improve neighbors documentation Apr 15, 2020
@haochunchang haochunchang changed the title [MRG] DOC Improve neighbors documentation [WIP] DOC Improve neighbors documentation Apr 16, 2020
@haochunchang haochunchang changed the title [WIP] DOC Improve neighbors documentation [MRG] DOC Improve neighbors documentation Apr 16, 2020
Copy link
Copy Markdown
Member

@TomDLT TomDLT left a comment

Choose a reason for hiding this comment

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

LGTM, thanks !

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.

Thanks for the PR @haochunchang !

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 @haochunchang !

LGTM

@thomasjpfan thomasjpfan changed the title [MRG] DOC Improve neighbors documentation DOC Improve neighbors documentation Apr 17, 2020
@thomasjpfan thomasjpfan merged commit 7a77214 into scikit-learn:master Apr 17, 2020
@haochunchang haochunchang deleted the fix_neighbors_document branch April 27, 2020 14:59
gio8tisu pushed a commit to gio8tisu/scikit-learn that referenced this pull request May 15, 2020
viclafargue pushed a commit to viclafargue/scikit-learn that referenced this pull request Jun 26, 2020
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