Backport PR #30910: DOC: Improve writer parameter docs of Animation.save()

timhoffm · meeseeksmachine · commit 44431a6e9439 · 2026-01-02T20:57:47.000Z
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -951,9 +951,21 @@ def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
         filename : str
             The output filename, e.g., :file:`mymovie.mp4`.
 
-        writer : `MovieWriter` or str, default: :rc:`animation.writer`
-            A `MovieWriter` instance to use or a key that identifies a
-            class to use, such as 'ffmpeg'.
+        writer : `AbstractMovieWriter` subclass or str, default: :rc:`animation.writer`
+            The writer used to grab the frames and create the movie file.
+            This can be an instance of an `AbstractMovieWriter` subclass or a
+            string. The builtin writers are
+
+            ==================  ==============================
+            str                 class
+            ==================  ==============================
+            'ffmpeg'            `.FFMpegWriter`
+            'ffmpeg_file'       `.FFMpegFileWriter`
+            'imagemagick'       `.ImageMagickWriter`
+            'imagemagick_file'  `.ImageMagickFileWriter`
+            'pillow'            `.PillowWriter`
+            'html'              `.HTMLWriter`
+            ==================  ==============================
 
         fps : int, optional
             Movie frame rate (per second).  If not set, the frame rate from the
