Backport PR #16532: Document default value of save_count parameter in FuncAnimation

tacaswell · tacaswell · commit 02f32f0267a0 · 2020-02-16T19:09:47.000-05:00
Merge pull request #16532 from timhoffm/doc-save_count DOC: Document default value of save_count parameter in FuncAnimation Conflicts: lib/matplotlib/animation.py - collision with removing "optional" from docstrings
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -1615,8 +1615,10 @@ def init_func() -> iterable_of_artists
     fargs : tuple or None, optional
        Additional arguments to pass to each call to *func*.
 
-    save_count : int, optional
-       The number of values from *frames* to cache.
+    save_count : int, default: 100
+        Fallback for the number of values from *frames* to cache. This is
+        only used if the number of frames cannot be inferred from *frames*,
+        i.e. when it's an iterator without length or a generator.
 
     interval : number, optional
        Delay between frames in milliseconds.  Defaults to 200.
