Small animation docs/style fixes.

anntzer · anntzer · commit a810948f0ab2 · 2022-10-21T14:35:31.000+02:00
Clarify that it is OK to pass blit=True even if the backend does not
support it.  Tweak the progress_callback example to avoid a backslash
escape.  Small additional doc/style fixes.
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -840,7 +840,8 @@ class Animation:
         system notifications.
 
     blit : bool, default: False
-        Whether blitting is used to optimize drawing.
+        Whether blitting is used to optimize drawing.  If the backend does not
+        support blitting, then this parameter has no effect.
 
     See Also
     --------
@@ -956,7 +957,7 @@ class to use, such as 'ffmpeg'.
         extra_anim : list, default: []
             Additional `Animation` objects that should be included
             in the saved movie file. These need to be from the same
-            `matplotlib.figure.Figure` instance. Also, animation frames will
+            `.Figure` instance. Also, animation frames will
             just be simply combined, so there should be a 1:1 correspondence
             between the frames from the different animations.
 
@@ -977,8 +978,7 @@ def func(current_frame: int, total_frames: int) -> Any
 
             Example code to write the progress to stdout::
 
-                progress_callback =\
-                    lambda i, n: print(f'Saving frame {i} of {n}')
+                progress_callback = lambda i, n: print(f'Saving frame {i}/{n}')
 
         Notes
         -----
@@ -1025,9 +1025,8 @@ def func(current_frame: int, total_frames: int) -> Any
 
         all_anim = [self]
         if extra_anim is not None:
-            all_anim.extend(anim
-                            for anim
-                            in extra_anim if anim._fig is self._fig)
+            all_anim.extend(anim for anim in extra_anim
+                            if anim._fig is self._fig)
 
         # If we have the name of a writer, instantiate an instance of the
         # registered class.
