Fixed formatting issues with nested enumerated docstrings in info_array descriptions

for all the cases in info_array which include value types of all cases
of enumerated values.

Author: daexs

_plotly_utils/basevalidators.py

@@ -537,8 +537,8 @@ def description(self):
             enum_vals_str = "\n".join(
                 textwrap.wrap(
                     repr(enum_vals),
-                    initial_indent=" " * 12,
-                    subsequent_indent=" " * 12,
+                    initial_indent=" " * 8,
+                    subsequent_indent=" " * 8,
                     break_on_hyphens=False,
                 )
             )
@@ -554,8 +554,8 @@ def description(self):
             enum_regexs_str = "\n".join(
                 textwrap.wrap(
                     repr(enum_regexs),
-                    initial_indent=" " * 12,
-                    subsequent_indent=" " * 12,
+                    initial_indent=" " * 8,
+                    subsequent_indent=" " * 8,
                     break_on_hyphens=False,
                     break_long_words=False,
                 )
@@ -572,7 +572,7 @@ def description(self):
             desc = (
                 desc
                 + """\n
-      - A tuple, list, or one-dimensional numpy array of the above"""
+    - A tuple, list, or one-dimensional numpy array of the above"""
             )
 
         return desc
@@ -727,23 +727,23 @@ def description(self):
             desc = (
                 desc
                 + """\n
-        - An int or float"""
+    - An int or float"""
             )
 
         else:
             desc = (
                 desc
-                + """
-      - An int or float in the interval [{min_val}, {max_val}]""".format(
+                + """\n
+    - An int or float in the interval [{min_val}, {max_val}]""".format(
                     min_val=self.min_val, max_val=self.max_val
                 )
             )
 
         if self.array_ok:
             desc = (
                 desc
-                + """
-      - A tuple, list, or one-dimensional numpy array of the above"""
+                + """\n
+    - A tuple, list, or one-dimensional numpy array of the above"""
             )
 
         return desc
@@ -1992,10 +1992,12 @@ def description(self):
 
                 for i, item_validator in enumerate(self.item_validators):
                     el_desc = item_validator.description().strip()
+                    lines = el_desc.splitlines()
+                    el_desc_indented = '\n'.join([lines[0]] + ['    ' + line for line in lines[1:]])
                     desc = (
                         desc
                         + """\n
-        ({i}) {el_desc}""".format(i=i, el_desc=el_desc)
+        ({i}) {el_desc_indented}""".format(i=i, el_desc_indented=el_desc_indented)
                     )
 
             # ### Case 2 ###
@@ -2030,21 +2032,28 @@ def description(self):
 
                 el_desc = item_validator.description().strip()
 
-                desc += """
-    * a list of elements where:
-      {el_desc}
-""".format(el_desc=el_desc)
+                # Adds an indentation of 4 spaces, especially when el_desc 
+                # is a fully auto-generated docstring with nested lists.
+                lines = el_desc.splitlines()
+                el_desc_indented = '\n'.join([lines[0]] + ['    ' + line for line in lines[1:]])
+
+                desc += """\n
+    * a list of elements where:\n
+        {el_desc_indented}
+""".format(el_desc_indented=el_desc_indented)
 
             if self.dimensions in ("1-2", 2):
                 item_validator.plotly_name = "{name}\\\\[i\\\\]\\\\[j\\\\]".format(
                     name=self.plotly_name
                 )
 
                 el_desc = item_validator.description().strip()
+                lines = el_desc.splitlines()
+                el_desc_indented = '\n'.join([lines[0]] + ['    ' + line for line in lines[1:]])
                 desc += """\n
     * a 2D list where:\n    
-        {el_desc}
-""".format(el_desc=el_desc)
+        {el_desc_indented}
+""".format(el_desc_indented=el_desc_indented)
 
             item_validator.plotly_name = orig_name
 

plotly/graph_objects/_bar.py

@@ -172,8 +172,10 @@ def constraintext(self):
         larger than the bar itself.
 
         The 'constraintext' property is an enumeration that may be specified as:
-          - One of the following enumeration values:
-                ['inside', 'outside', 'both', 'none']
+
+        - One of the following enumeration values:
+
+            ['inside', 'outside', 'both', 'none']
 
         Returns
         -------
@@ -232,7 +234,7 @@ def dx(self):
 
         The 'dx' property is a number and may be specified as:
 
-            - An int or float
+        - An int or float
 
         Returns
         -------
@@ -251,7 +253,7 @@ def dy(self):
 
         The 'dy' property is a number and may be specified as:
 
-            - An int or float
+        - An int or float
 
         Returns
         -------
@@ -514,8 +516,10 @@ def insidetextanchor(self):
         `textposition` "inside" mode.
 
         The 'insidetextanchor' property is an enumeration that may be specified as:
-          - One of the following enumeration values:
-                ['end', 'middle', 'start']
+
+        - One of the following enumeration values:
+
+            ['end', 'middle', 'start']
 
         Returns
         -------
@@ -625,7 +629,7 @@ def legendrank(self):
 
         The 'legendrank' property is a number and may be specified as:
 
-            - An int or float
+        - An int or float
 
         Returns
         -------
@@ -644,7 +648,8 @@ def legendwidth(self):
         trace.
 
         The 'legendwidth' property is a number and may be specified as:
-          - An int or float in the interval [0, inf]
+
+        - An int or float in the interval [0, inf]
 
         Returns
         -------
@@ -748,8 +753,9 @@ def offset(self):
 
         The 'offset' property is a number and may be specified as:
 
-            - An int or float
-          - A tuple, list, or one-dimensional numpy array of the above
+        - An int or float
+
+        - A tuple, list, or one-dimensional numpy array of the above
 
         Returns
         -------
@@ -806,7 +812,8 @@ def opacity(self):
         Sets the opacity of the trace.
 
         The 'opacity' property is a number and may be specified as:
-          - An int or float in the interval [0, 1]
+
+        - An int or float in the interval [0, 1]
 
         Returns
         -------
@@ -825,8 +832,10 @@ def orientation(self):
         the each bar spans along the vertical (horizontal).
 
         The 'orientation' property is an enumeration that may be specified as:
-          - One of the following enumeration values:
-                ['v', 'h']
+
+        - One of the following enumeration values:
+
+            ['v', 'h']
 
         Returns
         -------
@@ -1020,9 +1029,12 @@ def textposition(self):
         text appears.
 
         The 'textposition' property is an enumeration that may be specified as:
-          - One of the following enumeration values:
-                ['inside', 'outside', 'auto', 'none']
-          - A tuple, list, or one-dimensional numpy array of the above
+
+        - One of the following enumeration values:
+
+            ['inside', 'outside', 'auto', 'none']
+
+        - A tuple, list, or one-dimensional numpy array of the above
 
         Returns
         -------
@@ -1201,8 +1213,10 @@ def visible(self):
         legend item (provided that the legend itself is visible).
 
         The 'visible' property is an enumeration that may be specified as:
-          - One of the following enumeration values:
-                [True, False, 'legendonly']
+
+        - One of the following enumeration values:
+
+            [True, False, 'legendonly']
 
         Returns
         -------
@@ -1220,8 +1234,10 @@ def width(self):
         Sets the bar width (in position axis units).
 
         The 'width' property is a number and may be specified as:
-          - An int or float in the interval [0, inf]
-          - A tuple, list, or one-dimensional numpy array of the above
+
+        - An int or float in the interval [0, inf]
+
+        - A tuple, list, or one-dimensional numpy array of the above
 
         Returns
         -------
@@ -1317,11 +1333,13 @@ def xcalendar(self):
         Sets the calendar system to use with `x` date data.
 
         The 'xcalendar' property is an enumeration that may be specified as:
-          - One of the following enumeration values:
-                ['chinese', 'coptic', 'discworld', 'ethiopian',
-                'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
-                'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
-                'thai', 'ummalqura']
+
+        - One of the following enumeration values:
+
+            ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian',
+            'hebrew', 'islamic', 'jalali', 'julian', 'mayan',
+            'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai',
+            'ummalqura']
 
         Returns
         -------
@@ -1410,8 +1428,10 @@ def xperiodalignment(self):
         alignment of data points on the x axis.
 
         The 'xperiodalignment' property is an enumeration that may be specified as:
-          - One of the following enumeration values:
-                ['start', 'middle', 'end']
+
+        - One of the following enumeration values:
+
+            ['start', 'middle', 'end']
 
         Returns
         -------
@@ -1507,11 +1527,13 @@ def ycalendar(self):
         Sets the calendar system to use with `y` date data.
 
         The 'ycalendar' property is an enumeration that may be specified as:
-          - One of the following enumeration values:
-                ['chinese', 'coptic', 'discworld', 'ethiopian',
-                'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
-                'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
-                'thai', 'ummalqura']
+
+        - One of the following enumeration values:
+
+            ['chinese', 'coptic', 'discworld', 'ethiopian', 'gregorian',
+            'hebrew', 'islamic', 'jalali', 'julian', 'mayan',
+            'nanakshahi', 'nepali', 'persian', 'taiwan', 'thai',
+            'ummalqura']
 
         Returns
         -------
@@ -1600,8 +1622,10 @@ def yperiodalignment(self):
         alignment of data points on the y axis.
 
         The 'yperiodalignment' property is an enumeration that may be specified as:
-          - One of the following enumeration values:
-                ['start', 'middle', 'end']
+
+        - One of the following enumeration values:
+
+            ['start', 'middle', 'end']
 
         Returns
         -------