Skip to content

Commit 969aba4

Browse files
Improved doc string for dendrogram
1 parent 58a6f95 commit 969aba4

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

Diff for: packages/python/plotly/plotly/figure_factory/_dendrogram.py

+7-8
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,13 @@ def create_dendrogram(
3333
:param (ndarray) X: Matrix of observations as array of arrays
3434
:param (str) orientation: 'top', 'right', 'bottom', or 'left'
3535
:param (list) labels: List of axis category labels(observation labels)
36-
:param (list) colorscale: Optional colorscale for the dendrogram tree. With
37-
scipy<=1.4.1 requires 8 colors to be specified,
38-
the 7th of which is ignored. With scipy>=1.5.0,
39-
requires 10 colors. In this case the 8th color is
40-
ignored and the 2nd, 3rd and 6th are used twice as
41-
often as the others. Given a shorter list, the
42-
missing values are replaced with defaults and with
43-
a longer list the extra values are ignored.
36+
:param (list) colorscale: Optional colorscale for the dendrogram tree.
37+
Requires 8 colors to be specified, the 7th of
38+
which is ignored. With scipy>=1.5.0, the 2nd, 3rd
39+
and 6th are used twice as often as the others.
40+
Given a shorter list, the missing values are
41+
replaced with defaults and with a longer list the
42+
extra values are ignored.
4443
:param (function) distfun: Function to compute the pairwise distance from
4544
the observations
4645
:param (function) linkagefun: Function to compute the linkage matrix from

0 commit comments

Comments
 (0)