Skip to content

Doc: Add passing args to Animation guide #27621

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

Closed
story645 opened this issue Jan 9, 2024 · 6 comments · May be fixed by #27675
Closed

Doc: Add passing args to Animation guide #27621

story645 opened this issue Jan 9, 2024 · 6 comments · May be fixed by #27675
Labels
Documentation: user guide files in galleries/users_explain or doc/users Good first issue Open a pull request against these issues if there are no active ones! topic: animation

Comments

@story645
Copy link
Member

story645 commented Jan 9, 2024

Documentation Link

https://matplotlib.org/devdocs/users/explain/animations/animations.html#animations

Problem

Superceded by #27687

Based on #27620, this is a general enough usage case that it'd be worth adding a section.

Suggested improvement

Add a subsection to the FuncAnimation section and use that section to explain how to pass in arguments and show a small example.

See func parameter for details: https://matplotlib.org/devdocs/api/_as_gen/matplotlib.animation.FuncAnimation.html#matplotlib.animation.FuncAnimation

@story645 story645 added topic: animation Documentation: user guide files in galleries/users_explain or doc/users Good first issue Open a pull request against these issues if there are no active ones! labels Jan 9, 2024
Copy link

github-actions bot commented Jan 9, 2024

Good first issue - notes for new contributors

This issue is suited to new contributors because it does not require understanding of the Matplotlib internals. To get started, please see our contributing guide.

We do not assign issues. Check the Development section in the sidebar for linked pull requests (PRs). If there are none, feel free to start working on it. If there is an open PR, please collaborate on the work by reviewing it rather than duplicating it in a competing PR.

If something is unclear, please reach out on any of our communication channels.

@Ahmedniz1
Copy link

Is this request still available? I'm trying to work on it but I feel like the description is clear enough. As an example is attached right below the funcanimation heading describing how to create animation using this class.

@story645
Copy link
Member Author

As an example is attached right below the funcanimation heading describing how to create animation using this class

Sorry, may not have been clear enough in what I'm asking for then.

I think it'd be good to have a second example showing how to write/use animation update functions that take arguments, i.e.:

def update(frame, input1, input2):

How to do this is described in the FuncAnimation docstring.

@vamshipy
Copy link

working on this..

@MostafaNouh0011
Copy link
Contributor

Hello,
I am interested in contributing to this issue and would like to inquire if anyone is currently working on it.

@story645
Copy link
Member Author

@MostafaNouh0011 this issue is supereceded by #27687 so that's the one you should target. I had left this open because of the attached PR but I'm gonna close this to reduce confusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: user guide files in galleries/users_explain or doc/users Good first issue Open a pull request against these issues if there are no active ones! topic: animation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants