You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/python/plotly/plotly/express/_doc.py
+31-25Lines changed: 31 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -10,17 +10,21 @@
10
10
# TODO document "or `None`, default `None`" in various places
11
11
# TODO standardize positioning and casing of 'default'
12
12
13
-
colref= ("str or int or Series or array-like",
14
-
"Either a name of a column in `data_frame`, or a pandas Series or array_like object.")
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
+
)
15
17
16
-
colref_list= ("list of str or int, or Series or array-like",
17
-
"Either names of columns in `data_frame`, or pandas Series, or array_like objects")
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
+
)
18
22
19
23
docs=dict(
20
24
data_frame=[
21
25
"DataFrame or array-like or dict",
22
26
"This argument needs to be passed for column names (and not keyword names) to be used.",
23
-
"Array-like and dict are tranformed internally to a pandas DataFrame."
27
+
"Array-like and dict are tranformed internally to a pandas DataFrame.",
24
28
],
25
29
x=[
26
30
*colref,
@@ -107,9 +111,7 @@
107
111
*colref,
108
112
"Values from this column or array_like are used to assign color to marks.",
109
113
],
110
-
opacity=[
111
-
"float",
112
-
"Value between 0 and 1. Sets the opacity for markers."],
114
+
opacity=["float", "Value between 0 and 1. Sets the opacity for markers."],
113
115
line_dash=[
114
116
*colref,
115
117
"Values from this column or array_like are used to assign dash-patterns to lines.",
@@ -164,8 +166,8 @@
164
166
"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.",
165
167
],
166
168
symbol_sequence=[
167
-
"list of str"
168
-
"Strings should define valid plotly.js symbols.",
169
+
"list of str",
170
+
"Strings should define valid plotly.js symbols.",
169
171
"When `symbol` is set, values in that column are assigned symbols by cycling through `symbol_sequence` in the order described in `category_orders`, unless the value of `symbol` is a key in `symbol_map`.",
170
172
],
171
173
symbol_map=[
@@ -339,33 +341,34 @@
339
341
"`None` will stack up all values at each location coordinate.",
340
342
],
341
343
barmode=[
342
-
"str (default `'relative'`)"
344
+
"str (default `'relative'`)",
343
345
"One of `'group'`, `'overlay'` or `'relative'`",
344
346
"In `'relative'` mode, bars are stacked above zero for positive values and below zero for negative values.",
345
347
"In `'overlay'` mode, bars are drawn on top of one another.",
346
348
"In `'group'` mode, bars are placed beside each other.",
347
349
],
348
350
boxmode=[
349
-
"str (default `'group'`)"
351
+
"str (default `'group'`)",
350
352
"One of `'group'` or `'overlay'`",
351
353
"In `'overlay'` mode, boxes are on drawn top of one another.",
352
354
"In `'group'` mode, baxes are placed beside each other.",
353
355
],
354
356
violinmode=[
355
-
"str (default `'group'`)"
357
+
"str (default `'group'`)",
356
358
"One of `'group'` or `'overlay'`",
357
359
"In `'overlay'` mode, violins are on drawn top of one another.",
358
360
"In `'group'` mode, violins are placed beside each other.",
359
361
],
360
362
stripmode=[
361
-
"str (default `'group'`)"
363
+
"str (default `'group'`)",
362
364
"One of `'group'` or `'overlay'`",
363
365
"In `'overlay'` mode, strips are on drawn top of one another.",
364
366
"In `'group'` mode, strips are placed beside each other.",
0 commit comments