Skip to content

[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

Open
story645 opened this issue Jan 22, 2024 · 4 comments
Open
Labels
Difficulty: Medium https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation: API files in lib/ and doc/api Documentation: user guide files in galleries/users_explain or doc/users topic: animation

Comments

@story645
Copy link
Member

story645 commented Jan 22, 2024

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.

@story645 story645 added topic: animation Documentation: user guide files in galleries/users_explain or doc/users Documentation: API files in lib/ and doc/api labels Jan 22, 2024
@story645 story645 changed the title [Doc]: integerate Animation API explanatory material with animation guides [Doc]: integerate Animation API explanatory material into animation guides Jan 22, 2024
@QuLogic QuLogic changed the title [Doc]: integerate Animation API explanatory material into animation guides [Doc]: integrate Animation API explanatory material into animation guides Jan 23, 2024
@ShivamPathak99
Copy link
Contributor

Are these the objectives?

  1. Move FuncAnimation Content:

    • Move the content currently residing in the API FuncAnimation section to the existing simple animation guide.
  2. Restructure API Page:

    • Restructure the API page to include links pointing to the animation guide.
  3. Remove Subsections:

    • Remove the subsections for ArtistAnimation from the API page.

@story645
Copy link
Member Author

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:

  1. 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.

  2. 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.

  3. Maybe this was implied by 1., but both FuncAnimation and ArtistAnimation should end up removed

@ShivamPathak99
Copy link
Contributor

Did I got it right ?

@story645
Copy link
Member Author

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.

@story645 story645 added the Difficulty: Medium https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues label Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty: Medium https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation: API files in lib/ and doc/api Documentation: user guide files in galleries/users_explain or doc/users topic: animation
Projects
None yet
Development

No branches or pull requests

2 participants