update docstring

Author: LiamConnors

packages/python/plotly/plotly/figure_factory/_dendrogram.py

@@ -21,59 +21,63 @@ def create_dendrogram(
     color_threshold=None,
 ):
     """
-    Function that returns a dendrogram Plotly figure object. This is a thin
-    wrapper around scipy.cluster.hierarchy.dendrogram.
-
-    See also https://dash.plot.ly/dash-bio/clustergram.
-
-    :param (ndarray) X: Matrix of observations as array of arrays
-    :param (str) orientation: 'top', 'right', 'bottom', or 'left'
-    :param (list) labels: List of axis category labels(observation labels)
-    :param (list) colorscale: Optional colorscale for the dendrogram tree.
-                              Requires 8 colors to be specified, the 7th of
-                              which is ignored.  With scipy>=1.5.0, the 2nd, 3rd
-                              and 6th are used twice as often as the others.
-                              Given a shorter list, the missing values are
-                              replaced with defaults and with a longer list the
-                              extra values are ignored.
-    :param (function) distfun: Function to compute the pairwise distance from
-                               the observations
-    :param (function) linkagefun: Function to compute the linkage matrix from
-                               the pairwise distances
-    :param (list[list]) hovertext: List of hovertext for constituent traces of dendrogram
-                               clusters
-    :param (double) color_threshold: Value at which the separation of clusters will be made
-
+    Create a dendrogram Plotly figure object.
+
+    This function is a thin wrapper around `scipy.cluster.hierarchy.dendrogram`.
+
+    Parameters
+    ----------
+    X : ndarray
+        Matrix of observations as array of arrays.
+    orientation : str
+        'top', 'right', 'bottom', or 'left'. Default is 'bottom'.
+    labels : list
+        List of axis category labels (observation labels).
+    colorscale : list
+        Optional colorscale for the dendrogram tree. Requires 8 colors to be specified,
+        the 7th of which is ignored. With scipy>=1.5.0, the 2nd, 3rd, and 6th are used
+        twice as often as the others. Given a shorter list, the missing values are replaced
+        with defaults and with a longer list the extra values are ignored.
+    distfun : function
+        Function to compute the pairwise distance from the observations.
+    linkagefun : function
+        Function to compute the linkage matrix from the pairwise distances.
+    hovertext : list of list
+        List of hovertext for constituent traces of dendrogram clusters.
+    color_threshold : float
+        Value at which the separation of clusters will be made.
+
+    Returns
+    -------
+    plotly.graph_objs._figure.Figure
+        A Plotly figure object representing the dendrogram.
+
+    Examples
+    --------
     Example 1: Simple bottom oriented dendrogram
 
     >>> from plotly.figure_factory import create_dendrogram
-
     >>> import numpy as np
-
-    >>> X = np.random.rand(10,10)
+    >>> X = np.random.rand(10, 10)
     >>> fig = create_dendrogram(X)
     >>> fig.show()
 
     Example 2: Dendrogram to put on the left of the heatmap
 
     >>> from plotly.figure_factory import create_dendrogram
-
     >>> import numpy as np
-
-    >>> X = np.random.rand(5,5)
+    >>> X = np.random.rand(5, 5)
     >>> names = ['Jack', 'Oxana', 'John', 'Chelsea', 'Mark']
     >>> dendro = create_dendrogram(X, orientation='right', labels=names)
-    >>> dendro.update_layout({'width':700, 'height':500}) # doctest: +SKIP
+    >>> dendro.update_layout({'width': 700, 'height': 500})  # doctest: +SKIP
     >>> dendro.show()
 
     Example 3: Dendrogram with Pandas
 
     >>> from plotly.figure_factory import create_dendrogram
-
     >>> import numpy as np
     >>> import pandas as pd
-
-    >>> Index= ['A','B','C','D','E','F','G','H','I','J']
+    >>> Index = ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J']
     >>> df = pd.DataFrame(abs(np.random.randn(10, 10)), index=Index)
     >>> fig = create_dendrogram(df, labels=Index)
     >>> fig.show()