Skip to content

Commit 6688d5d

Browse files
authored
DOC: Improve writer parameter docs of Animation.save() (matplotlib#30910)
Closes matplotlib#24159.
1 parent a9ed0e1 commit 6688d5d

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

lib/matplotlib/animation.py

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -955,9 +955,21 @@ 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 used to grab the frames and create the movie file.
960+
This can be an instance of an `AbstractMovieWriter` subclass or a
961+
string. The builtin writers are
962+
963+
================== ==============================
964+
str class
965+
================== ==============================
966+
'ffmpeg' `.FFMpegWriter`
967+
'ffmpeg_file' `.FFMpegFileWriter`
968+
'imagemagick' `.ImageMagickWriter`
969+
'imagemagick_file' `.ImageMagickFileWriter`
970+
'pillow' `.PillowWriter`
971+
'html' `.HTMLWriter`
972+
================== ==============================
961973
962974
fps : int, optional
963975
Movie frame rate (per second). If not set, the frame rate from the

0 commit comments

Comments
 (0)