Merge pull request #16532 from timhoffm/doc-save_count

tacaswell · web-flow · commit 2bf43924a4b3 · 2020-02-16T19:07:34.000-05:00
DOC: Document default value of save_count parameter in FuncAnimation
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -1577,8 +1577,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 : int, default: 200
         Delay between frames in milliseconds.
