|
10 | 10 | # TODO document "or `None`, default `None`" in various places |
11 | 11 | # TODO standardize positioning and casing of 'default' |
12 | 12 |
|
13 | | -colref = ( |
14 | | - "str or int or Series or array-like", |
15 | | - "Either a name of a column in `data_frame`, or a pandas Series or array_like object.", |
16 | | -) |
17 | | - |
18 | | -colref_list = ( |
19 | | - "list of str or int, or Series or array-like", |
20 | | - "Either names of columns in `data_frame`, or pandas Series, or array_like objects", |
21 | | -) |
| 13 | +colref_type = "str or int or Series or array-like" |
| 14 | +colref_desc = "Either a name of a column in `data_frame`, or a pandas Series or array_like object." |
| 15 | +colref_list_type = "list of str or int, or Series or array-like" |
| 16 | +colref_list_desc = "Either names of columns in `data_frame`, or pandas Series, or array_like objects" |
22 | 17 |
|
23 | 18 | docs = dict( |
24 | 19 | data_frame=[ |
|
27 | 22 | "Array-like and dict are tranformed internally to a pandas DataFrame.", |
28 | 23 | ], |
29 | 24 | x=[ |
30 | | - *colref, |
| 25 | + colref_type, colref_desc, |
31 | 26 | "Values from this column or array_like are used to position marks along the x axis in cartesian coordinates.", |
32 | 27 | "For horizontal `histogram`s, these values are used as inputs to `histfunc`.", |
33 | 28 | ], |
34 | 29 | y=[ |
35 | | - *colref, |
| 30 | + colref_type, colref_desc, |
36 | 31 | "Values from this column or array_like are used to position marks along the y axis in cartesian coordinates.", |
37 | 32 | "For vertical `histogram`s, these values are used as inputs to `histfunc`.", |
38 | 33 | ], |
39 | 34 | z=[ |
40 | | - *colref, |
| 35 | + colref_type, colref_desc, |
41 | 36 | "Values from this column or array_like are used to position marks along the z axis in cartesian coordinates.", |
42 | 37 | "For `density_heatmap` and `density_contour` these values are used as the inputs to `histfunc`.", |
43 | 38 | ], |
44 | 39 | a=[ |
45 | | - *colref, |
| 40 | + colref_type, colref_desc, |
46 | 41 | "Values from this column or array_like are used to position marks along the a axis in ternary coordinates.", |
47 | 42 | ], |
48 | 43 | b=[ |
49 | | - *colref, |
| 44 | + colref_type, colref_desc, |
50 | 45 | "Values from this column or array_like are used to position marks along the b axis in ternary coordinates.", |
51 | 46 | ], |
52 | 47 | c=[ |
53 | | - *colref, |
| 48 | + colref_type, colref_desc, |
54 | 49 | "Values from this column or array_like are used to position marks along the c axis in ternary coordinates.", |
55 | 50 | ], |
56 | 51 | r=[ |
57 | | - *colref, |
| 52 | + colref_type, colref_desc, |
58 | 53 | "Values from this column or array_like are used to position marks along the radial axis in polar coordinates.", |
59 | 54 | ], |
60 | 55 | theta=[ |
61 | | - *colref, |
| 56 | + colref_type, colref_desc, |
62 | 57 | "Values from this column or array_like are used to position marks along the angular axis in polar coordinates.", |
63 | 58 | ], |
64 | 59 | lat=[ |
65 | | - *colref, |
| 60 | + colref_type, colref_desc, |
66 | 61 | "Values from this column or array_like are used to position marks according to latitude on a map.", |
67 | 62 | ], |
68 | 63 | lon=[ |
69 | | - *colref, |
| 64 | + colref_type, colref_desc, |
70 | 65 | "Values from this column or array_like are used to position marks according to longitude on a map.", |
71 | 66 | ], |
72 | 67 | locations=[ |
73 | | - *colref, |
| 68 | + colref_type, colref_desc, |
74 | 69 | "Values from this column or array_like are to be interpreted according to `locationmode` and mapped to longitude/latitude.", |
75 | 70 | ], |
76 | 71 | dimensions=[ |
77 | 72 | "list of str", |
78 | 73 | "Names of columns in `data_frame` to be used in multidimensional visualization.", |
79 | 74 | ], |
80 | 75 | error_x=[ |
81 | | - *colref, |
| 76 | + colref_type, colref_desc, |
82 | 77 | "Values from this column or array_like are used to size x-axis error bars.", |
83 | 78 | "If `error_x_minus` is `None`, error bars will be symmetrical, otherwise `error_x` is used for the positive direction only.", |
84 | 79 | ], |
85 | 80 | error_x_minus=[ |
86 | | - *colref, |
| 81 | + colref_type, colref_desc, |
87 | 82 | "Values from this column or array_like are used to size x-axis error bars in the negative direction.", |
88 | 83 | "Ignored if `error_x` is `None`.", |
89 | 84 | ], |
90 | 85 | error_y=[ |
91 | | - *colref, |
| 86 | + colref_type, colref_desc, |
92 | 87 | "Values from this column or array_like are used to size y-axis error bars.", |
93 | 88 | "If `error_y_minus` is `None`, error bars will be symmetrical, otherwise `error_y` is used for the positive direction only.", |
94 | 89 | ], |
95 | 90 | error_y_minus=[ |
96 | | - *colref, |
| 91 | + colref_type, colref_desc, |
97 | 92 | "Values from this column or array_like are used to size y-axis error bars in the negative direction.", |
98 | 93 | "Ignored if `error_y` is `None`.", |
99 | 94 | ], |
100 | 95 | error_z=[ |
101 | | - *colref, |
| 96 | + colref_type, colref_desc, |
102 | 97 | "Values from this column or array_like are used to size z-axis error bars.", |
103 | 98 | "If `error_z_minus` is `None`, error bars will be symmetrical, otherwise `error_z` is used for the positive direction only.", |
104 | 99 | ], |
105 | 100 | error_z_minus=[ |
106 | | - *colref, |
| 101 | + colref_type, colref_desc, |
107 | 102 | "Values from this column or array_like are used to size z-axis error bars in the negative direction.", |
108 | 103 | "Ignored if `error_z` is `None`.", |
109 | 104 | ], |
110 | 105 | color=[ |
111 | | - *colref, |
| 106 | + colref_type, colref_desc, |
112 | 107 | "Values from this column or array_like are used to assign color to marks.", |
113 | 108 | ], |
114 | 109 | opacity=["float", "Value between 0 and 1. Sets the opacity for markers."], |
115 | 110 | line_dash=[ |
116 | | - *colref, |
| 111 | + colref_type, colref_desc, |
117 | 112 | "Values from this column or array_like are used to assign dash-patterns to lines.", |
118 | 113 | ], |
119 | 114 | line_group=[ |
120 | | - *colref, |
| 115 | + colref_type, colref_desc, |
121 | 116 | "Values from this column or array_like are used to group rows of `data_frame` into lines.", |
122 | 117 | ], |
123 | 118 | symbol=[ |
124 | | - *colref, |
| 119 | + colref_type, colref_desc, |
125 | 120 | "Values from this column or array_like are used to assign symbols to marks.", |
126 | 121 | ], |
127 | 122 | size=[ |
128 | | - *colref, |
| 123 | + colref_type, colref_desc, |
129 | 124 | "Values from this column or array_like are used to assign mark sizes.", |
130 | 125 | ], |
131 | 126 | hover_name=[ |
132 | | - *colref, |
| 127 | + colref_type, colref_desc, |
133 | 128 | "Values from this column or array_like appear in bold in the hover tooltip.", |
134 | 129 | ], |
135 | 130 | hover_data=[ |
136 | | - *colref_list, |
| 131 | + colref_list_type, colref_list_desc, |
137 | 132 | "Values from these columns appear as extra data in the hover tooltip.", |
138 | 133 | ], |
139 | 134 | custom_data=[ |
140 | | - *colref_list, |
| 135 | + colref_list_type, colref_list_desc, |
141 | 136 | "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.)", |
142 | 137 | ], |
143 | 138 | text=[ |
144 | | - *colref, |
| 139 | + colref_type, colref_desc, |
145 | 140 | "Values from this column or array_like appear in the figure as text labels.", |
146 | 141 | ], |
147 | 142 | locationmode=[ |
|
150 | 145 | "Determines the set of locations used to match entries in `locations` to regions on the map.", |
151 | 146 | ], |
152 | 147 | facet_row=[ |
153 | | - *colref, |
| 148 | + colref_type, colref_desc, |
154 | 149 | "Values from this column or array_like are used to assign marks to facetted subplots in the vertical direction.", |
155 | 150 | ], |
156 | 151 | facet_col=[ |
157 | | - *colref, |
| 152 | + colref_type, colref_desc, |
158 | 153 | "Values from this column or array_like are used to assign marks to facetted subplots in the horizontal direction.", |
159 | 154 | ], |
160 | 155 | animation_frame=[ |
161 | | - *colref, |
| 156 | + colref_type, colref_desc, |
162 | 157 | "Values from this column or array_like are used to assign marks to animation frames.", |
163 | 158 | ], |
164 | 159 | animation_group=[ |
165 | | - *colref, |
| 160 | + colref_type, colref_desc, |
166 | 161 | "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.", |
167 | 162 | ], |
168 | 163 | symbol_sequence=[ |
|
0 commit comments