Skip to content

Commit 4ca1aa3

Browse files
committed
Let black autoformat list items and long strings
1 parent cf7f8d4 commit 4ca1aa3

File tree

1 file changed

+63
-31
lines changed
  • packages/python/plotly/plotly/express

1 file changed

+63
-31
lines changed

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

+63-31
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
colref_type = "str or int or Series or array-like"
1414
colref_desc = "Either a name of a column in `data_frame`, or a pandas Series or array_like object."
1515
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"
16+
colref_list_desc = (
17+
"Either names of columns in `data_frame`, or pandas Series, or array_like objects"
18+
)
1719

1820
docs = dict(
1921
data_frame=[
@@ -22,121 +24,147 @@
2224
"Array-like and dict are tranformed internally to a pandas DataFrame.",
2325
],
2426
x=[
25-
colref_type, colref_desc,
27+
colref_type,
28+
colref_desc,
2629
"Values from this column or array_like are used to position marks along the x axis in cartesian coordinates.",
2730
"For horizontal `histogram`s, these values are used as inputs to `histfunc`.",
2831
],
2932
y=[
30-
colref_type, colref_desc,
33+
colref_type,
34+
colref_desc,
3135
"Values from this column or array_like are used to position marks along the y axis in cartesian coordinates.",
3236
"For vertical `histogram`s, these values are used as inputs to `histfunc`.",
3337
],
3438
z=[
35-
colref_type, colref_desc,
39+
colref_type,
40+
colref_desc,
3641
"Values from this column or array_like are used to position marks along the z axis in cartesian coordinates.",
3742
"For `density_heatmap` and `density_contour` these values are used as the inputs to `histfunc`.",
3843
],
3944
a=[
40-
colref_type, colref_desc,
45+
colref_type,
46+
colref_desc,
4147
"Values from this column or array_like are used to position marks along the a axis in ternary coordinates.",
4248
],
4349
b=[
44-
colref_type, colref_desc,
50+
colref_type,
51+
colref_desc,
4552
"Values from this column or array_like are used to position marks along the b axis in ternary coordinates.",
4653
],
4754
c=[
48-
colref_type, colref_desc,
55+
colref_type,
56+
colref_desc,
4957
"Values from this column or array_like are used to position marks along the c axis in ternary coordinates.",
5058
],
5159
r=[
52-
colref_type, colref_desc,
60+
colref_type,
61+
colref_desc,
5362
"Values from this column or array_like are used to position marks along the radial axis in polar coordinates.",
5463
],
5564
theta=[
56-
colref_type, colref_desc,
65+
colref_type,
66+
colref_desc,
5767
"Values from this column or array_like are used to position marks along the angular axis in polar coordinates.",
5868
],
5969
lat=[
60-
colref_type, colref_desc,
70+
colref_type,
71+
colref_desc,
6172
"Values from this column or array_like are used to position marks according to latitude on a map.",
6273
],
6374
lon=[
64-
colref_type, colref_desc,
75+
colref_type,
76+
colref_desc,
6577
"Values from this column or array_like are used to position marks according to longitude on a map.",
6678
],
6779
locations=[
68-
colref_type, colref_desc,
80+
colref_type,
81+
colref_desc,
6982
"Values from this column or array_like are to be interpreted according to `locationmode` and mapped to longitude/latitude.",
7083
],
7184
dimensions=[
7285
"list of str",
7386
"Names of columns in `data_frame` to be used in multidimensional visualization.",
7487
],
7588
error_x=[
76-
colref_type, colref_desc,
89+
colref_type,
90+
colref_desc,
7791
"Values from this column or array_like are used to size x-axis error bars.",
7892
"If `error_x_minus` is `None`, error bars will be symmetrical, otherwise `error_x` is used for the positive direction only.",
7993
],
8094
error_x_minus=[
81-
colref_type, colref_desc,
95+
colref_type,
96+
colref_desc,
8297
"Values from this column or array_like are used to size x-axis error bars in the negative direction.",
8398
"Ignored if `error_x` is `None`.",
8499
],
85100
error_y=[
86-
colref_type, colref_desc,
101+
colref_type,
102+
colref_desc,
87103
"Values from this column or array_like are used to size y-axis error bars.",
88104
"If `error_y_minus` is `None`, error bars will be symmetrical, otherwise `error_y` is used for the positive direction only.",
89105
],
90106
error_y_minus=[
91-
colref_type, colref_desc,
107+
colref_type,
108+
colref_desc,
92109
"Values from this column or array_like are used to size y-axis error bars in the negative direction.",
93110
"Ignored if `error_y` is `None`.",
94111
],
95112
error_z=[
96-
colref_type, colref_desc,
113+
colref_type,
114+
colref_desc,
97115
"Values from this column or array_like are used to size z-axis error bars.",
98116
"If `error_z_minus` is `None`, error bars will be symmetrical, otherwise `error_z` is used for the positive direction only.",
99117
],
100118
error_z_minus=[
101-
colref_type, colref_desc,
119+
colref_type,
120+
colref_desc,
102121
"Values from this column or array_like are used to size z-axis error bars in the negative direction.",
103122
"Ignored if `error_z` is `None`.",
104123
],
105124
color=[
106-
colref_type, colref_desc,
125+
colref_type,
126+
colref_desc,
107127
"Values from this column or array_like are used to assign color to marks.",
108128
],
109129
opacity=["float", "Value between 0 and 1. Sets the opacity for markers."],
110130
line_dash=[
111-
colref_type, colref_desc,
131+
colref_type,
132+
colref_desc,
112133
"Values from this column or array_like are used to assign dash-patterns to lines.",
113134
],
114135
line_group=[
115-
colref_type, colref_desc,
136+
colref_type,
137+
colref_desc,
116138
"Values from this column or array_like are used to group rows of `data_frame` into lines.",
117139
],
118140
symbol=[
119-
colref_type, colref_desc,
141+
colref_type,
142+
colref_desc,
120143
"Values from this column or array_like are used to assign symbols to marks.",
121144
],
122145
size=[
123-
colref_type, colref_desc,
146+
colref_type,
147+
colref_desc,
124148
"Values from this column or array_like are used to assign mark sizes.",
125149
],
126150
hover_name=[
127-
colref_type, colref_desc,
151+
colref_type,
152+
colref_desc,
128153
"Values from this column or array_like appear in bold in the hover tooltip.",
129154
],
130155
hover_data=[
131-
colref_list_type, colref_list_desc,
156+
colref_list_type,
157+
colref_list_desc,
132158
"Values from these columns appear as extra data in the hover tooltip.",
133159
],
134160
custom_data=[
135-
colref_list_type, colref_list_desc,
161+
colref_list_type,
162+
colref_list_desc,
136163
"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.)",
137164
],
138165
text=[
139-
colref_type, colref_desc,
166+
colref_type,
167+
colref_desc,
140168
"Values from this column or array_like appear in the figure as text labels.",
141169
],
142170
locationmode=[
@@ -145,19 +173,23 @@
145173
"Determines the set of locations used to match entries in `locations` to regions on the map.",
146174
],
147175
facet_row=[
148-
colref_type, colref_desc,
176+
colref_type,
177+
colref_desc,
149178
"Values from this column or array_like are used to assign marks to facetted subplots in the vertical direction.",
150179
],
151180
facet_col=[
152-
colref_type, colref_desc,
181+
colref_type,
182+
colref_desc,
153183
"Values from this column or array_like are used to assign marks to facetted subplots in the horizontal direction.",
154184
],
155185
animation_frame=[
156-
colref_type, colref_desc,
186+
colref_type,
187+
colref_desc,
157188
"Values from this column or array_like are used to assign marks to animation frames.",
158189
],
159190
animation_group=[
160-
colref_type, colref_desc,
191+
colref_type,
192+
colref_desc,
161193
"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.",
162194
],
163195
symbol_sequence=[

0 commit comments

Comments
 (0)