Reformat colref variables to support Python2.7

Author: joelostblom

Diff for: packages/python/plotly/plotly/express/_doc.py

@@ -10,15 +10,10 @@
 # TODO document "or `None`, default `None`" in various places
 # TODO standardize positioning and casing of 'default'
 
-colref = (
-    "str or int or Series or array-like",
-    "Either a name of a column in `data_frame`, or a pandas Series or array_like object.",
-)
-
-colref_list = (
-    "list of str or int, or Series or array-like",
-    "Either names of columns in `data_frame`, or pandas Series, or array_like objects",
-)
+colref_type = "str or int or Series or array-like"
+colref_desc = "Either a name of a column in `data_frame`, or a pandas Series or array_like object."
+colref_list_type = "list of str or int, or Series or array-like"
+colref_list_desc = "Either names of columns in `data_frame`, or pandas Series, or array_like objects"
 
 docs = dict(
     data_frame=[
@@ -27,121 +22,121 @@
         "Array-like and dict are tranformed internally to a pandas DataFrame.",
     ],
     x=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to position marks along the x axis in cartesian coordinates.",
         "For horizontal `histogram`s, these values are used as inputs to `histfunc`.",
     ],
     y=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to position marks along the y axis in cartesian coordinates.",
         "For vertical `histogram`s, these values are used as inputs to `histfunc`.",
     ],
     z=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to position marks along the z axis in cartesian coordinates.",
         "For `density_heatmap` and `density_contour` these values are used as the inputs to `histfunc`.",
     ],
     a=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to position marks along the a axis in ternary coordinates.",
     ],
     b=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to position marks along the b axis in ternary coordinates.",
     ],
     c=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to position marks along the c axis in ternary coordinates.",
     ],
     r=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to position marks along the radial axis in polar coordinates.",
     ],
     theta=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to position marks along the angular axis in polar coordinates.",
     ],
     lat=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to position marks according to latitude on a map.",
     ],
     lon=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to position marks according to longitude on a map.",
     ],
     locations=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are to be interpreted according to `locationmode` and mapped to longitude/latitude.",
     ],
     dimensions=[
         "list of str",
         "Names of columns in `data_frame` to be used in multidimensional visualization.",
     ],
     error_x=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to size x-axis error bars.",
         "If `error_x_minus` is `None`, error bars will be symmetrical, otherwise `error_x` is used for the positive direction only.",
     ],
     error_x_minus=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to size x-axis error bars in the negative direction.",
         "Ignored if `error_x` is `None`.",
     ],
     error_y=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to size y-axis error bars.",
         "If `error_y_minus` is `None`, error bars will be symmetrical, otherwise `error_y` is used for the positive direction only.",
     ],
     error_y_minus=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to size y-axis error bars in the negative direction.",
         "Ignored if `error_y` is `None`.",
     ],
     error_z=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to size z-axis error bars.",
         "If `error_z_minus` is `None`, error bars will be symmetrical, otherwise `error_z` is used for the positive direction only.",
     ],
     error_z_minus=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to size z-axis error bars in the negative direction.",
         "Ignored if `error_z` is `None`.",
     ],
     color=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to assign color to marks.",
     ],
     opacity=["float", "Value between 0 and 1. Sets the opacity for markers."],
     line_dash=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to assign dash-patterns to lines.",
     ],
     line_group=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to group rows of `data_frame` into lines.",
     ],
     symbol=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to assign symbols to marks.",
     ],
     size=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to assign mark sizes.",
     ],
     hover_name=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like appear in bold in the hover tooltip.",
     ],
     hover_data=[
-        *colref_list,
+        colref_list_type, colref_list_desc,
         "Values from these columns appear as extra data in the hover tooltip.",
     ],
     custom_data=[
-        *colref_list,
+        colref_list_type, colref_list_desc,
         "Values from these columns are extra data, to be used in widgets or Dash callbacks for example. This data is not user-visible but is included in events emitted by the figure (lasso selection etc.)",
     ],
     text=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like appear in the figure as text labels.",
     ],
     locationmode=[
@@ -150,19 +145,19 @@
         "Determines the set of locations used to match entries in `locations` to regions on the map.",
     ],
     facet_row=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to assign marks to facetted subplots in the vertical direction.",
     ],
     facet_col=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to assign marks to facetted subplots in the horizontal direction.",
     ],
     animation_frame=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to assign marks to animation frames.",
     ],
     animation_group=[
-        *colref,
+        colref_type, colref_desc,
         "Values from this column or array_like are used to provide object-constancy across animation frames: rows with matching `animation_group`s will be treated as if they describe the same object in each frame.",
     ],
     symbol_sequence=[