Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c5339c1

Browse files
committed
Updated doc strings
1 parent d1709b0 commit c5339c1

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

plotly/tools.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1507,10 +1507,10 @@ def _map_face2color(face, colormap, vmin, vmax):
15071507
"""
15081508
Normalize facecolor values by vmin/vmax and return rgb-color strings
15091509
1510-
This function takes a tuple color with elements between 0 and 1, along
1511-
with a colormap and a minimum (vmin) and maximum (vmax) range of
1512-
possible mean distances for the given parametrized surface. It returns
1513-
an rgb color based on the mean distance between vmin and vmax
1510+
This function takes a tuple color along with a colormap and a minimum
1511+
(vmin) and maximum (vmax) range of possible mean distances for the
1512+
given parametrized surface. It returns an rgb color based on the mean
1513+
distance between vmin and vmax
15141514
15151515
"""
15161516
if vmin >= vmax:
@@ -1679,10 +1679,12 @@ def create_trisurf(x, y, z, simplices, colormap=None, color_func=None,
16791679
:param (array) simplices: an array of shape (ntri, 3) where ntri is
16801680
the number of triangles in the triangularization. Each row of the
16811681
array contains the indicies of the verticies of each triangle
1682-
:param (str|list) colormap: either a plotly scale name, or a list
1683-
containing 2 triplets. These triplets must be of the form (a,b,c)
1684-
or 'rgb(x,y,z)' where a,b,c belong to the interval [0,1] and x,y,z
1685-
belong to [0,255]
1682+
:param (str|tuple|list) colormap: either a plotly scale name, an rgb
1683+
or hex color, a color tuple or a list of colors. An rgb color is
1684+
of the form 'rgb(x, y, z)' where x, y, z belong to the interval
1685+
[0, 255] and a color tuple is a tuple of the form (a, b, c) where
1686+
a, b and c belong to [0, 1]. If colormap is a list, it must
1687+
contain the valid color types aforementioned as its members.
16861688
:param (function|list) color_func: The parameter that determines the
16871689
coloring of the surface. Takes either a function with 3 arguments
16881690
x, y, z or a list/array of color values the same length as

0 commit comments

Comments
 (0)