Document that TimedAnimation should not be used

QuLogic · QuLogic · commit 38ae5318360b · 2026-04-18T04:31:24.000-04:00
This copies the text from `Animation`, but also puts both in a warning box. Fixes #30831
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -853,10 +853,7 @@ def finish(self):
 
 class Animation:
     """
-    A base class for Animations.
-
-    This class is not usable as is, and should be subclassed to provide needed
-    behavior.
+    Abstract base class for Animations.
 
     .. note::
 
@@ -1425,6 +1422,11 @@ class TimedAnimation(Animation):
 
     A new frame is drawn every *interval* milliseconds.
 
+    .. warning::
+
+        This class is not usable as is, and should be subclassed to provide needed
+        behavior.
+
     .. note::
 
         You must store the created Animation in a variable that lives as long
