Skip to content

DOC Update KernelDensity docstrings#15468

Merged
TomDLT merged 4 commits intoscikit-learn:masterfrom
sam-dixon:kde_docstring
Nov 2, 2019
Merged

DOC Update KernelDensity docstrings#15468
TomDLT merged 4 commits intoscikit-learn:masterfrom
sam-dixon:kde_docstring

Conversation

@sam-dixon
Copy link
Copy Markdown
Contributor

@sam-dixon sam-dixon commented Nov 2, 2019

Reference Issues/PRs

#15440

What does this implement/fix? Explain your changes.

Brings docstring style in line with numpydoc. Added an example and see also links to KDTree and BallTree

Any other comments?

Copy link
Copy Markdown
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.

Minor comment otherwise LGTM.

@TomDLT TomDLT merged commit 0f434ef into scikit-learn:master Nov 2, 2019
@TomDLT
Copy link
Copy Markdown
Member

TomDLT commented Nov 2, 2019

Thanks @sam-dixon !

@sam-dixon sam-dixon deleted the kde_docstring branch November 2, 2019 18:40
rth added a commit that referenced this pull request Nov 2, 2019
Address missing review comment from #15468
>>> rng = np.random.RandomState(42)
>>> X = rng.random_sample((100, 3))
>>> kde = KernelDensity(kernel='gaussian', bandwidth=0.5).fit(X)
KernelDensity(...)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This should have been removed as well, as it make doctest fail. Fixed in 726eac9 on master.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

oops, thanks !

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