Repository navigation
[Doc]: integrate Animation API explanatory material into animation guides #27687
Description
Documentation Link
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.
Activity
[-][Doc]: integerate Animation API explanatory material with animation guides[/-][+][Doc]: integerate Animation API explanatory material into animation guides[/+][-][Doc]: integerate Animation API explanatory material into animation guides[/-][+][Doc]: integrate Animation API explanatory material into animation guides[/+]ShivamPathak99 commentedon Jan 24, 2024
Are these the objectives?
Move FuncAnimation Content:
FuncAnimationsection to the existingsimple animation guide.Restructure API Page:
animation guide.Remove Subsections:
ArtistAnimationfrom the API page.story645 commentedon Jan 24, 2024
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:
The content overlaps, so it's a matter of folding in the material as appropriate and in the appropriate places. Just moving it will create too much duplication and put content in the wrong places.
I don't think the page needs restructuring - I used rework just because some sentences may need to be moved around to create a clean flow for emphasizing the link out to the animation guides.
Maybe this was implied by 1., but both
FuncAnimationandArtistAnimationshould end up removedShivamPathak99 commentedon Jan 25, 2024
Did I got it right ?
story645 commentedon Jan 25, 2024
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.
sairakhatoon-cyberbuzz commentedon May 4, 2026
Hi! I'm a new contributor and would love
to work on this issue. Is it still available?
I have read the animation API docs and the
animation guide and understand what needs
to be done. Can I take this?
story645 commentedon May 4, 2026
@sairakhatoon-cyberbuzz go for it - we don't require permission for working on issues.
Update animation_api.rst
Update animation_api.rst