Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c6e105f

Browse files
committed
Document that TimedAnimation should not be used
This copies the text from `Animation`, but also puts both in a warning box. Fixes #30831
1 parent 471e079 commit c6e105f

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

lib/matplotlib/animation.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -855,8 +855,10 @@ class Animation:
855855
"""
856856
A base class for Animations.
857857
858-
This class is not usable as is, and should be subclassed to provide needed
859-
behavior.
858+
.. warning::
859+
860+
This class is not usable as is, and should be subclassed to provide needed
861+
behavior.
860862
861863
.. note::
862864
@@ -1425,6 +1427,11 @@ class TimedAnimation(Animation):
14251427
14261428
A new frame is drawn every *interval* milliseconds.
14271429
1430+
.. warning::
1431+
1432+
This class is not usable as is, and should be subclassed to provide needed
1433+
behavior.
1434+
14281435
.. note::
14291436
14301437
You must store the created Animation in a variable that lives as long

0 commit comments

Comments
 (0)