conditional docstring

Author: nicolaskruchten

Diff for: packages/python/plotly/_plotly_utils/basevalidators.py

@@ -1675,11 +1675,14 @@ def __init__(self, plotly_name, parent_name, array_ok=False, **kwargs):
     def description(self):
         desc = """\
     The '{plotly_name}' property is a angle (in degrees) that may be
-    specified as a number between -180 and 180. Numeric values outside this
-    range are converted to the equivalent value
+    specified as a number between -180 and 180{array_ok}.
+    Numeric values outside this range are converted to the equivalent value
     (e.g. 270 is converted to -90).
         """.format(
-            plotly_name=self.plotly_name
+            plotly_name=self.plotly_name,
+            array_ok=", or a list, numpy array or other iterable thereof"
+            if self.array_ok
+            else "",
         )
 
         return desc

Diff for: packages/python/plotly/plotly/graph_objs/_bar.py

@@ -1374,8 +1374,8 @@ def textangle(self):
         the maximum size in bars.
 
         The 'textangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/_funnel.py

@@ -1150,8 +1150,8 @@ def textangle(self):
         the maximum size in bars.
 
         The 'textangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/_histogram.py

@@ -1450,8 +1450,8 @@ def textangle(self):
         the maximum size in bars.
 
         The 'textangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/_parcoords.py

@@ -302,8 +302,8 @@ def labelangle(self):
         margins when `labelposition` is set to "bottom".
 
         The 'labelangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/_pie.py

@@ -970,8 +970,8 @@ def rotation(self):
         some other angle.
 
         The 'rotation' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/_sunburst.py

@@ -1065,8 +1065,8 @@ def rotation(self):
         default the first slice starts at 3 o'clock.
 
         The 'rotation' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/_waterfall.py

@@ -1173,8 +1173,8 @@ def textangle(self):
         the maximum size in bars.
 
         The 'textangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/bar/marker/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/barpolar/marker/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/box/_marker.py

@@ -26,8 +26,8 @@ def angle(self):
         Sets the marker angle in respect to `angleref`.
 
         The 'angle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/carpet/_aaxis.py

@@ -1253,8 +1253,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/carpet/_baxis.py

@@ -1253,8 +1253,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/choropleth/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/choroplethmapbox/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/cone/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/contour/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/contourcarpet/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/densitymapbox/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/funnel/marker/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/heatmap/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/heatmapgl/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/histogram/marker/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/histogram2d/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/histogram2dcontour/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/icicle/marker/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/indicator/gauge/_axis.py

@@ -319,8 +319,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/isosurface/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/layout/_annotation.py

@@ -918,8 +918,8 @@ def textangle(self):
         horizontal.
 
         The 'textangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/layout/_xaxis.py

@@ -1859,8 +1859,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/layout/_yaxis.py

@@ -1782,8 +1782,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/layout/coloraxis/_colorbar.py

@@ -640,8 +640,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns

Diff for: packages/python/plotly/plotly/graph_objs/layout/polar/_angularaxis.py

@@ -631,8 +631,8 @@ def rotation(self):
         corresponds to due North (like on a compass),
 
         The 'rotation' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns
@@ -854,8 +854,8 @@ def tickangle(self):
         labels vertically.
 
         The 'tickangle' property is a angle (in degrees) that may be
-        specified as a number between -180 and 180. Numeric values outside this
-        range are converted to the equivalent value
+        specified as a number between -180 and 180.
+        Numeric values outside this range are converted to the equivalent value
         (e.g. 270 is converted to -90).
 
         Returns