Skip to content

Commit 2f0ea8b

Browse files
authored
Backport PR matplotlib#30910: DOC: Improve writer parameter docs of Animation.save() (matplotlib#30924)
Co-authored-by: Tim Hoffmann <[email protected]>
2 parents 97c4e07 + 5f66224 commit 2f0ea8b

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
@@ -951,9 +951,21 @@ def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
951951
filename : str
952952
The output filename, e.g., :file:`mymovie.mp4`.
953953
954-
writer : `MovieWriter` or str, default: :rc:`animation.writer`
955-
A `MovieWriter` instance to use or a key that identifies a
956-
class to use, such as 'ffmpeg'.
954+
writer : `AbstractMovieWriter` subclass or str, default: :rc:`animation.writer`
955+
The writer used to grab the frames and create the movie file.
956+
This can be an instance of an `AbstractMovieWriter` subclass or a
957+
string. The builtin writers are
958+
959+
================== ==============================
960+
str class
961+
================== ==============================
962+
'ffmpeg' `.FFMpegWriter`
963+
'ffmpeg_file' `.FFMpegFileWriter`
964+
'imagemagick' `.ImageMagickWriter`
965+
'imagemagick_file' `.ImageMagickFileWriter`
966+
'pillow' `.PillowWriter`
967+
'html' `.HTMLWriter`
968+
================== ==============================
957969
958970
fps : int, optional
959971
Movie frame rate (per second). If not set, the frame rate from the

0 commit comments

Comments
 (0)