Skip to content

DOC Ensures that get_bin_seeds passes numpydoc validation #22018

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

Merged
merged 2 commits into from
Dec 19, 2021
Merged

DOC Ensures that get_bin_seeds passes numpydoc validation #22018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40b549a
Make summary start with infinitive verb
melemo2 Dec 19, 2021
6a665f7
Merge remote-tracking branch 'upstream/main' into pr/22018
thomasjpfan Dec 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sklearn/cluster/_mean_shift.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ def mean_shift(


def get_bin_seeds(X, bin_size, min_bin_freq=1):
"""Finds seeds for mean_shift.
"""Find seeds for mean_shift.

Finds seeds by first binning data onto a grid whose lines are
spaced bin_size apart, and then choosing those bins with at least
Expand Down
1 change: 0 additions & 1 deletion sklearn/tests/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@

FUNCTION_DOCSTRING_IGNORE_LIST = [
"sklearn.cluster._kmeans.kmeans_plusplus",
"sklearn.cluster._mean_shift.get_bin_seeds",
"sklearn.cluster._optics.cluster_optics_xi",
"sklearn.cluster._optics.compute_optics_graph",
"sklearn.cluster._spectral.spectral_clustering",
Expand Down