Skip to content

Commit c30a3d2

Browse files
Merge pull request plotly#2893 from bandersen23/show-docstring-i2653
add width, height, and config to .show docstring
2 parents 0cb9cc8 + 74d3bae commit c30a3d2

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

packages/python/plotly/plotly/basedatatypes.py

+12
Original file line numberDiff line numberDiff line change
@@ -3376,6 +3376,18 @@ def show(self, *args, **kwargs):
33763376
True if the figure should be validated before being shown,
33773377
False otherwise.
33783378
3379+
width: int or float
3380+
An integer or float that determines the number of pixels wide the
3381+
plot is. The default is set in plotly.js.
3382+
3383+
height: int or float
3384+
An integer or float that determines the number of pixels wide the
3385+
plot is. The default is set in plotly.js.
3386+
3387+
config: dict
3388+
A dict of parameters to configure the figure. The defaults are set
3389+
in plotly.js.
3390+
33793391
Returns
33803392
-------
33813393
None

packages/python/plotly/plotly/io/_renderers.py

+12
Original file line numberDiff line numberDiff line change
@@ -367,6 +367,18 @@ def show(fig, renderer=None, validate=True, **kwargs):
367367
True if the figure should be validated before being shown,
368368
False otherwise.
369369
370+
width: int or float
371+
An integer or float that determines the number of pixels wide the
372+
plot is. The default is set in plotly.js.
373+
374+
height: int or float
375+
An integer or float that determines the number of pixels wide the
376+
plot is. The default is set in plotly.js.
377+
378+
config: dict
379+
A dict of parameters to configure the figure. The defaults are set
380+
in plotly.js.
381+
370382
Returns
371383
-------
372384
None

0 commit comments

Comments
 (0)