Update _trisurf.py

Author: LiamConnors

packages/python/plotly/plotly/figure_factory/_trisurf.py

@@ -263,44 +263,52 @@ def create_trisurf(
     aspectratio=None,
 ):
     """
-    Returns figure for a triangulated surface plot
-
-    :param (array) x: data values of x in a 1D array
-    :param (array) y: data values of y in a 1D array
-    :param (array) z: data values of z in a 1D array
-    :param (array) simplices: an array of shape (ntri, 3) where ntri is
-        the number of triangles in the triangularization. Each row of the
-        array contains the indicies of the verticies of each triangle
-    :param (str|tuple|list) colormap: either a plotly scale name, an rgb
-        or hex color, a color tuple or a list of colors. An rgb color is
-        of the form 'rgb(x, y, z)' where x, y, z belong to the interval
-        [0, 255] and a color tuple is a tuple of the form (a, b, c) where
-        a, b and c belong to [0, 1]. If colormap is a list, it must
-        contain the valid color types aforementioned as its members
-    :param (bool) show_colorbar: determines if colorbar is visible
-    :param (list|array) scale: sets the scale values to be used if a non-
-        linearly interpolated colormap is desired. If left as None, a
-        linear interpolation between the colors will be excecuted
-    :param (function|list) color_func: The parameter that determines the
-        coloring of the surface. Takes either a function with 3 arguments
-        x, y, z or a list/array of color values the same length as
-        simplices. If None, coloring will only depend on the z axis
-    :param (str) title: title of the plot
-    :param (bool) plot_edges: determines if the triangles on the trisurf
-        are visible
-    :param (bool) showbackground: makes background in plot visible
-    :param (str) backgroundcolor: color of background. Takes a string of
-        the form 'rgb(x,y,z)' x,y,z are between 0 and 255 inclusive
-    :param (str) gridcolor: color of the gridlines besides the axes. Takes
-        a string of the form 'rgb(x,y,z)' x,y,z are between 0 and 255
-        inclusive
-    :param (str) zerolinecolor: color of the axes. Takes a string of the
-        form 'rgb(x,y,z)' x,y,z are between 0 and 255 inclusive
-    :param (str) edges_color: color of the edges, if plot_edges is True
-    :param (int|float) height: the height of the plot (in pixels)
-    :param (int|float) width: the width of the plot (in pixels)
-    :param (dict) aspectratio: a dictionary of the aspect ratio values for
-        the x, y and z axes. 'x', 'y' and 'z' take (int|float) values
+    Returns figure for a triangulated surface plot.
+
+    Parameters
+    ----------
+    x : array
+        Data values of x in a 1D array.
+    y : array
+        Data values of y in a 1D array.
+    z : array
+        Data values of z in a 1D array.
+    simplices : array
+        An array of shape (ntri, 3) where ntri is the number of triangles in the triangularization. Each row of the
+        array contains the indices of the vertices of each triangle.
+    colormap : str, tuple, or list
+        Either a plotly scale name, an rgb or hex color, a color tuple, or a list of colors. An rgb color is of the form
+        'rgb(x, y, z)' where x, y, z belong to the interval [0, 255] and a color tuple is a tuple of the form (a, b, c)
+        where a, b, and c belong to [0, 1]. If colormap is a list, it must contain the valid color types aforementioned as
+        its members.
+    show_colorbar : bool
+        Determines if colorbar is visible.
+    scale : list or array
+        Sets the scale values to be used if a non-linearly interpolated colormap is desired. If left as None, a linear
+        interpolation between the colors will be executed.
+    color_func : function or list
+        The parameter that determines the coloring of the surface. Takes either a function with 3 arguments x, y, z or a
+        list/array of color values the same length as simplices. If None, coloring will only depend on the z axis.
+    title : str
+        Title of the plot.
+    plot_edges : bool
+        Determines if the triangles on the trisurf are visible.
+    showbackground : bool
+        Makes background in plot visible.
+    backgroundcolor : str
+        Color of background. Takes a string of the form 'rgb(x,y,z)' where x, y, z are between 0 and 255 inclusive.
+    gridcolor : str
+        Color of the gridlines besides the axes. Takes a string of the form 'rgb(x,y,z)' where x, y, z are between 0 and 255 inclusive.
+    zerolinecolor : str
+        Color of the axes. Takes a string of the form 'rgb(x,y,z)' where x, y, z are between 0 and 255 inclusive.
+    edges_color : str
+        Color of the edges, if plot_edges is True.
+    height : int or float
+        The height of the plot (in pixels).
+    width : int or float
+        The width of the plot (in pixels).
+    aspectratio : dict
+        A dictionary of the aspect ratio values for the x, y, and z axes. 'x', 'y', and 'z' take int or float values.
 
     Example 1: Sphere