Skip to content

Commit c769ad6

Browse files
committed
updated docstring
1 parent 89c53db commit c769ad6

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

plotly/offline/offline.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,18 @@ def enable_mpl_offline(resize=False, strip_style=False,
511511

512512
def download_notebook_image(format='png', height=600, width=800,
513513
filename='newplot'):
514+
"""
515+
Download an image of the most recent plot. This function should be
516+
called in a cell following the output cell that includes the plot.
514517
518+
Keyword arguments:
519+
format -- sets the image format for the saved file (default='png')
520+
Accepts formats include: .jpeg, .png, .svg, .webp
521+
height -- sets the height of the image in px (default=600)
522+
width -- sets the width of the image in px (default=800)
523+
filename -- the name of the saved file without format extension
524+
(default='newplot')
525+
"""
515526
script = ('<script>'
516527
'function downloadimage(format, height, width,'
517528
' filename) {{'

0 commit comments

Comments
 (0)