@@ -303,7 +303,7 @@ def _axis_spanning_shapes_docstr(shape_type):
303
303
304
304
Parameters
305
305
----------
306
- y: float or int
306
+ y : float or int
307
307
A number representing the y coordinate of the horizontal line."""
308
308
elif shape_type == "vline" :
309
309
docstr = """
@@ -312,7 +312,7 @@ def _axis_spanning_shapes_docstr(shape_type):
312
312
313
313
Parameters
314
314
----------
315
- x: float or int
315
+ x : float or int
316
316
A number representing the x coordinate of the vertical line."""
317
317
elif shape_type == "hrect" :
318
318
docstr = """
@@ -321,9 +321,9 @@ def _axis_spanning_shapes_docstr(shape_type):
321
321
322
322
Parameters
323
323
----------
324
- y0: float or int
324
+ y0 : float or int
325
325
A number representing the y coordinate of one side of the rectangle.
326
- y1: float or int
326
+ y1 : float or int
327
327
A number representing the y coordinate of the other side of the rectangle."""
328
328
elif shape_type == "vrect" :
329
329
docstr = """
@@ -332,49 +332,49 @@ def _axis_spanning_shapes_docstr(shape_type):
332
332
333
333
Parameters
334
334
----------
335
- x0: float or int
335
+ x0 : float or int
336
336
A number representing the x coordinate of one side of the rectangle.
337
- x1: float or int
337
+ x1 : float or int
338
338
A number representing the x coordinate of the other side of the rectangle."""
339
339
docstr += """
340
- exclude_empty_subplots: Boolean
340
+ exclude_empty_subplots : Boolean
341
341
If True (default) do not place the shape on subplots that have no data
342
342
plotted on them.
343
- row: None, int or 'all'
343
+ row : None, int or 'all'
344
344
Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
345
345
the specified column(s). If both row and col are None, addresses the
346
346
first subplot if subplots exist, or the only plot. By default is "all".
347
- col: None, int or 'all'
347
+ col : None, int or 'all'
348
348
Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
349
349
the specified column(s). If both row and col are None, addresses the
350
350
first subplot if subplots exist, or the only plot. By default is "all".
351
- annotation: dict or plotly.graph_objs.layout.Annotation. If dict(),
351
+ annotation : dict or plotly.graph_objs.layout.Annotation. If dict(),
352
352
it is interpreted as describing an annotation. The annotation is
353
353
placed relative to the shape based on annotation_position (see
354
354
below) unless its x or y value has been specified for the annotation
355
355
passed here. xref and yref are always the same as for the added
356
356
shape and cannot be overridden."""
357
357
if shape_type in ["hline" , "vline" ]:
358
358
docstr += """
359
- annotation_position: a string containing optionally ["top", "bottom"]
359
+ annotation_position : a string containing optionally ["top", "bottom"]
360
360
and ["left", "right"] specifying where the text should be anchored
361
361
to on the line. Example positions are "bottom left", "right top",
362
362
"right", "bottom". If an annotation is added but annotation_position is
363
363
not specified, this defaults to "top right"."""
364
364
elif shape_type in ["hrect" , "vrect" ]:
365
365
docstr += """
366
- annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"]
366
+ annotation_position : a string containing optionally ["inside", "outside"], ["top", "bottom"]
367
367
and ["left", "right"] specifying where the text should be anchored
368
368
to on the rectangle. Example positions are "outside top left", "inside
369
369
bottom", "right", "inside left", "inside" ("outside" is not supported). If
370
370
an annotation is added but annotation_position is not specified this
371
371
defaults to "inside top right"."""
372
372
docstr += """
373
- annotation_*: any parameters to go.layout.Annotation can be passed as
373
+ annotation_* : any parameters to go.layout.Annotation can be passed as
374
374
keywords by prefixing them with "annotation_". For example, to specify the
375
375
annotation text "example" you can pass annotation_text="example" as a
376
376
keyword argument.
377
- **kwargs:
377
+ **kwargs :
378
378
Any named function parameters that can be passed to 'add_shape',
379
379
except for x0, x1, y0, y1 or type."""
380
380
return docstr
@@ -430,7 +430,7 @@ def __init__(
430
430
Parameters
431
431
----------
432
432
data
433
- One of:
433
+ One of:\n
434
434
- A list or tuple of trace objects (or dicts that can be coerced
435
435
into trace objects)
436
436
@@ -1374,8 +1374,8 @@ def update_traces(
1374
1374
properties that are not specified in the update operation.
1375
1375
**kwargs
1376
1376
Additional property updates to apply to each selected trace. If
1377
- a property is specified in both patch and in \* \*kwargs then the
1378
- one in \* \*kwargs takes precedence.
1377
+ a property is specified in both patch and in \\ \\ * \\ \ \ *kwargs then the
1378
+ one in \\ \\ * \\ \ \ *kwargs takes precedence.
1379
1379
1380
1380
Returns
1381
1381
-------
0 commit comments