Document that TimedAnimation should not be used#31512
Document that TimedAnimation should not be used#31512timhoffm merged 1 commit intomatplotlib:mainfrom
TimedAnimation should not be used#31512Conversation
| This class is not usable as is, and should be subclassed to provide needed | ||
| behavior. |
There was a problem hiding this comment.
Dunno which admonition it should get but I feel like this should be an admonition at the very top of the docstring
https://pydata-sphinx-theme.readthedocs.io/en/stable/examples/kitchen-sink/admonitions.html
There was a problem hiding this comment.
Just went with a normal .. warning::.
| behavior. | ||
| .. warning:: | ||
|
|
||
| This class is not usable as is, and should be subclassed to provide needed |
There was a problem hiding this comment.
The message is a bit vague. Let’s instead just say
Abstract base class for Animations.
in the summary line.
Precedent: https://matplotlib.org/devdocs/api/artist_api.html#artist-class
timhoffm
left a comment
There was a problem hiding this comment.
Accidentally clicked approve instead of request changes.
| @@ -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. | |||
There was a problem hiding this comment.
| behavior. | |
| Abstract `Animation` subclass for time-based animation. | |
| A new frame is drawn every *interval* milliseconds. |
Edit:
GitHub suggestion scope is buggy. What I meant here is: Do not use a warning either but change the summary line
Animationsubclass for time-based animation.
->
Abstract
Animationsubclass for time-based animation.
There was a problem hiding this comment.
I assume you meant to delete the warning on this one as well?
And also similarly change `Animation`. Fixes matplotlib#30831
PR summary
This copies the text from
Animation.Fixes #30831
AI Disclosure
None
PR checklist