Fixed formatting for 'Compound' and 'color' properties.

Author: daexs

_plotly_utils/basevalidators.py

@@ -1317,27 +1317,28 @@ def numbers_allowed(self):
     def description(self):
         valid_color_description = """\
     The '{plotly_name}' property is a color and may be specified as:
-      - A hex string (e.g. '#ff0000')
-      - An rgb/rgba string (e.g. 'rgb(255,0,0)')
-      - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
-      - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
-      - A named CSS color: see https://plotly.com/python/css-colors/ for a list""".format(
+
+    - A hex string (e.g. '#ff0000')
+    - An rgb/rgba string (e.g. 'rgb(255,0,0)')
+    - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
+    - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
+    - A named CSS color: see https://plotly.com/python/css-colors/ for a list""".format(
             plotly_name=self.plotly_name
         )
 
         if self.colorscale_path:
             valid_color_description = (
                 valid_color_description
                 + """
-      - A number that will be interpreted as a color
-        according to {colorscale_path}""".format(colorscale_path=self.colorscale_path)
-            )
+    - A number that will be interpreted as a color according to {colorscale_path}""".format(
+        colorscale_path=self.colorscale_path)
+        )
 
         if self.array_ok:
             valid_color_description = (
                 valid_color_description
                 + """
-      - A list or array of any of the above"""
+    - A list or array of any of the above"""
             )
 
         return valid_color_description
@@ -2419,10 +2420,9 @@ def description(self):
         desc = (
             """\
     The '{plotly_name}' property is an instance of {class_str}
-    that may be specified as:
-      - An instance of :class:`{module_str}.{class_str}`
-      - A dict of string/value properties that will be passed
-        to the {class_str} constructor"""
+    that may be specified as:\n
+    - An instance of :class:`{module_str}.{class_str}`
+    - A dict of string/value properties that will be passed to the {class_str} constructor"""
         ).format(
             plotly_name=self.plotly_name,
             class_str=self.data_class_str,

plotly/graph_objects/_bar.py

@@ -272,9 +272,9 @@ def error_x(self):
         """
         The 'error_x' property is an instance of ErrorX
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.ErrorX`
-          - A dict of string/value properties that will be passed
-            to the ErrorX constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.ErrorX`
+        - A dict of string/value properties that will be passed to the ErrorX constructor
 
         Returns
         -------
@@ -291,9 +291,9 @@ def error_y(self):
         """
         The 'error_y' property is an instance of ErrorY
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.ErrorY`
-          - A dict of string/value properties that will be passed
-            to the ErrorY constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.ErrorY`
+        - A dict of string/value properties that will be passed to the ErrorY constructor
 
         Returns
         -------
@@ -353,9 +353,9 @@ def hoverlabel(self):
         """
         The 'hoverlabel' property is an instance of Hoverlabel
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.Hoverlabel`
-          - A dict of string/value properties that will be passed
-            to the Hoverlabel constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.Hoverlabel`
+        - A dict of string/value properties that will be passed to the Hoverlabel constructor
 
         Returns
         -------
@@ -546,9 +546,9 @@ def insidetextfont(self):
 
         The 'insidetextfont' property is an instance of Insidetextfont
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.Insidetextfont`
-          - A dict of string/value properties that will be passed
-            to the Insidetextfont constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.Insidetextfont`
+        - A dict of string/value properties that will be passed to the Insidetextfont constructor
 
         Returns
         -------
@@ -611,9 +611,9 @@ def legendgrouptitle(self):
         """
         The 'legendgrouptitle' property is an instance of Legendgrouptitle
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.Legendgrouptitle`
-          - A dict of string/value properties that will be passed
-            to the Legendgrouptitle constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.Legendgrouptitle`
+        - A dict of string/value properties that will be passed to the Legendgrouptitle constructor
 
         Returns
         -------
@@ -676,9 +676,9 @@ def marker(self):
         """
         The 'marker' property is an instance of Marker
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.Marker`
-          - A dict of string/value properties that will be passed
-            to the Marker constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.Marker`
+        - A dict of string/value properties that will be passed to the Marker constructor
 
         Returns
         -------
@@ -868,9 +868,9 @@ def outsidetextfont(self):
 
         The 'outsidetextfont' property is an instance of Outsidetextfont
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.Outsidetextfont`
-          - A dict of string/value properties that will be passed
-            to the Outsidetextfont constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.Outsidetextfont`
+        - A dict of string/value properties that will be passed to the Outsidetextfont constructor
 
         Returns
         -------
@@ -887,9 +887,9 @@ def selected(self):
         """
         The 'selected' property is an instance of Selected
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.Selected`
-          - A dict of string/value properties that will be passed
-            to the Selected constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.Selected`
+        - A dict of string/value properties that will be passed to the Selected constructor
 
         Returns
         -------
@@ -947,9 +947,9 @@ def stream(self):
         """
         The 'stream' property is an instance of Stream
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.Stream`
-          - A dict of string/value properties that will be passed
-            to the Stream constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.Stream`
+        - A dict of string/value properties that will be passed to the Stream constructor
 
         Returns
         -------
@@ -1019,9 +1019,9 @@ def textfont(self):
 
         The 'textfont' property is an instance of Textfont
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.Textfont`
-          - A dict of string/value properties that will be passed
-            to the Textfont constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.Textfont`
+        - A dict of string/value properties that will be passed to the Textfont constructor
 
         Returns
         -------
@@ -1213,9 +1213,9 @@ def unselected(self):
         """
         The 'unselected' property is an instance of Unselected
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.bar.Unselected`
-          - A dict of string/value properties that will be passed
-            to the Unselected constructor
+
+        - An instance of :class:`plotly.graph_objects.bar.Unselected`
+        - A dict of string/value properties that will be passed to the Unselected constructor
 
         Returns
         -------

plotly/graph_objects/_barpolar.py

@@ -224,9 +224,9 @@ def hoverlabel(self):
         """
         The 'hoverlabel' property is an instance of Hoverlabel
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.barpolar.Hoverlabel`
-          - A dict of string/value properties that will be passed
-            to the Hoverlabel constructor
+
+        - An instance of :class:`plotly.graph_objects.barpolar.Hoverlabel`
+        - A dict of string/value properties that will be passed to the Hoverlabel constructor
 
         Returns
         -------
@@ -433,9 +433,9 @@ def legendgrouptitle(self):
         """
         The 'legendgrouptitle' property is an instance of Legendgrouptitle
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.barpolar.Legendgrouptitle`
-          - A dict of string/value properties that will be passed
-            to the Legendgrouptitle constructor
+
+        - An instance of :class:`plotly.graph_objects.barpolar.Legendgrouptitle`
+        - A dict of string/value properties that will be passed to the Legendgrouptitle constructor
 
         Returns
         -------
@@ -498,9 +498,9 @@ def marker(self):
         """
         The 'marker' property is an instance of Marker
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.barpolar.Marker`
-          - A dict of string/value properties that will be passed
-            to the Marker constructor
+
+        - An instance of :class:`plotly.graph_objects.barpolar.Marker`
+        - A dict of string/value properties that will be passed to the Marker constructor
 
         Returns
         -------
@@ -697,9 +697,9 @@ def selected(self):
         """
         The 'selected' property is an instance of Selected
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.barpolar.Selected`
-          - A dict of string/value properties that will be passed
-            to the Selected constructor
+
+        - An instance of :class:`plotly.graph_objects.barpolar.Selected`
+        - A dict of string/value properties that will be passed to the Selected constructor
 
         Returns
         -------
@@ -757,9 +757,9 @@ def stream(self):
         """
         The 'stream' property is an instance of Stream
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.barpolar.Stream`
-          - A dict of string/value properties that will be passed
-            to the Stream constructor
+
+        - An instance of :class:`plotly.graph_objects.barpolar.Stream`
+        - A dict of string/value properties that will be passed to the Stream constructor
 
         Returns
         -------
@@ -973,9 +973,9 @@ def unselected(self):
         """
         The 'unselected' property is an instance of Unselected
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.barpolar.Unselected`
-          - A dict of string/value properties that will be passed
-            to the Unselected constructor
+
+        - An instance of :class:`plotly.graph_objects.barpolar.Unselected`
+        - A dict of string/value properties that will be passed to the Unselected constructor
 
         Returns
         -------

plotly/graph_objects/_box.py

@@ -262,11 +262,12 @@ def fillcolor(self):
         is available.
 
         The 'fillcolor' property is a color and may be specified as:
-          - A hex string (e.g. '#ff0000')
-          - An rgb/rgba string (e.g. 'rgb(255,0,0)')
-          - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
-          - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
-          - A named CSS color: see https://plotly.com/python/css-colors/ for a list
+
+        - A hex string (e.g. '#ff0000')
+        - An rgb/rgba string (e.g. 'rgb(255,0,0)')
+        - An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
+        - An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
+        - A named CSS color: see https://plotly.com/python/css-colors/ for a list
 
         Returns
         -------
@@ -326,9 +327,9 @@ def hoverlabel(self):
         """
         The 'hoverlabel' property is an instance of Hoverlabel
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.box.Hoverlabel`
-          - A dict of string/value properties that will be passed
-            to the Hoverlabel constructor
+
+        - An instance of :class:`plotly.graph_objects.box.Hoverlabel`
+        - A dict of string/value properties that will be passed to the Hoverlabel constructor
 
         Returns
         -------
@@ -578,9 +579,9 @@ def legendgrouptitle(self):
         """
         The 'legendgrouptitle' property is an instance of Legendgrouptitle
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.box.Legendgrouptitle`
-          - A dict of string/value properties that will be passed
-            to the Legendgrouptitle constructor
+
+        - An instance of :class:`plotly.graph_objects.box.Legendgrouptitle`
+        - A dict of string/value properties that will be passed to the Legendgrouptitle constructor
 
         Returns
         -------
@@ -643,9 +644,9 @@ def line(self):
         """
         The 'line' property is an instance of Line
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.box.Line`
-          - A dict of string/value properties that will be passed
-            to the Line constructor
+
+        - An instance of :class:`plotly.graph_objects.box.Line`
+        - A dict of string/value properties that will be passed to the Line constructor
 
         Returns
         -------
@@ -703,9 +704,9 @@ def marker(self):
         """
         The 'marker' property is an instance of Marker
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.box.Marker`
-          - A dict of string/value properties that will be passed
-            to the Marker constructor
+
+        - An instance of :class:`plotly.graph_objects.box.Marker`
+        - A dict of string/value properties that will be passed to the Marker constructor
 
         Returns
         -------
@@ -1209,9 +1210,9 @@ def selected(self):
         """
         The 'selected' property is an instance of Selected
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.box.Selected`
-          - A dict of string/value properties that will be passed
-            to the Selected constructor
+
+        - An instance of :class:`plotly.graph_objects.box.Selected`
+        - A dict of string/value properties that will be passed to the Selected constructor
 
         Returns
         -------
@@ -1313,9 +1314,9 @@ def stream(self):
         """
         The 'stream' property is an instance of Stream
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.box.Stream`
-          - A dict of string/value properties that will be passed
-            to the Stream constructor
+
+        - An instance of :class:`plotly.graph_objects.box.Stream`
+        - A dict of string/value properties that will be passed to the Stream constructor
 
         Returns
         -------
@@ -1430,9 +1431,9 @@ def unselected(self):
         """
         The 'unselected' property is an instance of Unselected
         that may be specified as:
-          - An instance of :class:`plotly.graph_objects.box.Unselected`
-          - A dict of string/value properties that will be passed
-            to the Unselected constructor
+
+        - An instance of :class:`plotly.graph_objects.box.Unselected`
+        - A dict of string/value properties that will be passed to the Unselected constructor
 
         Returns
         -------