Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 56b9276

Browse files
committed
DOC: Improve writer parameter docs of Animation.save()
Closes matplotlib#24159.
1 parent 0088182 commit 56b9276

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

lib/matplotlib/animation.py

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -955,9 +955,20 @@ def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
955955
filename : str
956956
The output filename, e.g., :file:`mymovie.mp4`.
957957
958-
writer : `MovieWriter` or str, default: :rc:`animation.writer`
959-
A `MovieWriter` instance to use or a key that identifies a
960-
class to use, such as 'ffmpeg'.
958+
writer : `AbstractMovieWriter` subclass or str, default: :rc:`animation.writer`
959+
The writer to use. This can be an instance of an `AbstractMovieWriter`
960+
subclass or a string. The builtin writers are
961+
962+
================== ==============================
963+
str class
964+
================== ==============================
965+
'ffmpeg' `.FFMpegWriter`
966+
'ffmpeg_file' `.FFMpegFileWriter`
967+
'imagemagick' `.ImageMagickWriter`
968+
'imagemagick_file' `.ImageMagickFileWriter`
969+
'pillow' `.PillowWriter`
970+
'html' `.HTMLWriter`
971+
================== ==============================
961972
962973
fps : int, optional
963974
Movie frame rate (per second). If not set, the frame rate from the

0 commit comments

Comments
 (0)