Skip to content

Commit 31c8a2f

Browse files
committed
Fixed formatting issues and modified json file for double bracket error.
1 parent 95ea818 commit 31c8a2f

File tree

13 files changed

+158
-153
lines changed

13 files changed

+158
-153
lines changed

plotly/basedatatypes.py

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ def _axis_spanning_shapes_docstr(shape_type):
303303
304304
Parameters
305305
----------
306-
y: float or int
306+
y : float or int
307307
A number representing the y coordinate of the horizontal line."""
308308
elif shape_type == "vline":
309309
docstr = """
@@ -312,7 +312,7 @@ def _axis_spanning_shapes_docstr(shape_type):
312312
313313
Parameters
314314
----------
315-
x: float or int
315+
x : float or int
316316
A number representing the x coordinate of the vertical line."""
317317
elif shape_type == "hrect":
318318
docstr = """
@@ -321,9 +321,9 @@ def _axis_spanning_shapes_docstr(shape_type):
321321
322322
Parameters
323323
----------
324-
y0: float or int
324+
y0 : float or int
325325
A number representing the y coordinate of one side of the rectangle.
326-
y1: float or int
326+
y1 : float or int
327327
A number representing the y coordinate of the other side of the rectangle."""
328328
elif shape_type == "vrect":
329329
docstr = """
@@ -332,49 +332,49 @@ def _axis_spanning_shapes_docstr(shape_type):
332332
333333
Parameters
334334
----------
335-
x0: float or int
335+
x0 : float or int
336336
A number representing the x coordinate of one side of the rectangle.
337-
x1: float or int
337+
x1 : float or int
338338
A number representing the x coordinate of the other side of the rectangle."""
339339
docstr += """
340-
exclude_empty_subplots: Boolean
340+
exclude_empty_subplots : Boolean
341341
If True (default) do not place the shape on subplots that have no data
342342
plotted on them.
343-
row: None, int or 'all'
343+
row : None, int or 'all'
344344
Subplot row for shape indexed starting at 1. If 'all', addresses all rows in
345345
the specified column(s). If both row and col are None, addresses the
346346
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'
348348
Subplot column for shape indexed starting at 1. If 'all', addresses all rows in
349349
the specified column(s). If both row and col are None, addresses the
350350
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(),
352352
it is interpreted as describing an annotation. The annotation is
353353
placed relative to the shape based on annotation_position (see
354354
below) unless its x or y value has been specified for the annotation
355355
passed here. xref and yref are always the same as for the added
356356
shape and cannot be overridden."""
357357
if shape_type in ["hline", "vline"]:
358358
docstr += """
359-
annotation_position: a string containing optionally ["top", "bottom"]
359+
annotation_position : a string containing optionally ["top", "bottom"]
360360
and ["left", "right"] specifying where the text should be anchored
361361
to on the line. Example positions are "bottom left", "right top",
362362
"right", "bottom". If an annotation is added but annotation_position is
363363
not specified, this defaults to "top right"."""
364364
elif shape_type in ["hrect", "vrect"]:
365365
docstr += """
366-
annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"]
366+
annotation_position : a string containing optionally ["inside", "outside"], ["top", "bottom"]
367367
and ["left", "right"] specifying where the text should be anchored
368368
to on the rectangle. Example positions are "outside top left", "inside
369369
bottom", "right", "inside left", "inside" ("outside" is not supported). If
370370
an annotation is added but annotation_position is not specified this
371371
defaults to "inside top right"."""
372372
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
374374
keywords by prefixing them with "annotation_". For example, to specify the
375375
annotation text "example" you can pass annotation_text="example" as a
376376
keyword argument.
377-
**kwargs:
377+
**kwargs :
378378
Any named function parameters that can be passed to 'add_shape',
379379
except for x0, x1, y0, y1 or type."""
380380
return docstr
@@ -430,7 +430,7 @@ def __init__(
430430
Parameters
431431
----------
432432
data
433-
One of:
433+
One of:\n
434434
- A list or tuple of trace objects (or dicts that can be coerced
435435
into trace objects)
436436
@@ -1374,8 +1374,8 @@ def update_traces(
13741374
properties that are not specified in the update operation.
13751375
**kwargs
13761376
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.
13791379
13801380
Returns
13811381
-------

0 commit comments

Comments
 (0)