Skip to content

DOC Ensures that linkage_tree passes numpydoc validation #21424

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
Oct 23, 2021
Merged

DOC Ensures that linkage_tree passes numpydoc validation #21424

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
2655ea1
DOC numpydoc removed linkage_tree from FUNCTION_DOCSTRING_IGNORE_LIST
chritter Oct 23, 2021
680715a
DOC numpydoc fixed linkage_tree func docstring
chritter Oct 23, 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
1 change: 0 additions & 1 deletion maint_tools/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"sklearn._config.get_config",
"sklearn.base.clone",
"sklearn.cluster._affinity_propagation.affinity_propagation",
"sklearn.cluster._agglomerative.linkage_tree",
"sklearn.cluster._kmeans.k_means",
"sklearn.cluster._kmeans.kmeans_plusplus",
"sklearn.cluster._mean_shift.estimate_bandwidth",
Expand Down
4 changes: 2 additions & 2 deletions sklearn/cluster/_agglomerative.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,11 +429,11 @@ def linkage_tree(
observations of the two sets.

affinity : str or callable, default='euclidean'
which metric to use. Can be 'euclidean', 'manhattan', or any
Which metric to use. Can be 'euclidean', 'manhattan', or any
distance known to paired distance (see metric.pairwise).

return_distance : bool, default=False
whether or not to return the distances between the clusters.
Whether or not to return the distances between the clusters.

Returns
-------
Expand Down