-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
[Doc]: integrate Animation API explanatory material into animation guides #27687
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
Are these the objectives?
|
Thanks for checking! I think that this is an intermediate level documentation issue because the hard part is that the objectives aren't that clear cut:
|
Did I got it right ? |
Sorry, I appreciate you trying to tackle this but going by a skim I don't think so. Like I said, the hard part here is that you have to fold in the API content so that it flows with the content in the guide. That means possibly removing some of it altogether or moving it into the blitting guide - depending on what seems to be appropriate scope for each document. |
Documentation Link
https://matplotlib.org/devdocs/api/animation_api.html
Problem
The Animation API docs kinda have a mini explanation of how FuncAnimate works and all the different options that would be more appropriate for the animation guides. This feels especially odd compared to the barely-existent section for ArtistAnimation
Suggested improvement
Now that the simple animation guide exists, I think most of the content in the API FuncAnimation section should be moved there. Then the API page should be reworked a little so that it links out to the guide and the subsections for FuncAnimation and ArtistAnimation can be removed.
The text was updated successfully, but these errors were encountered: