Skip to content

Add note on keeping a reference to animation docstrings #18896

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

Merged
merged 1 commit into from
Nov 6, 2020

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Nov 4, 2020

PR Summary

I intentionally chose a note admonition over the numpydoc Notes section to make this more prominent. It's a bit on the nose, but it's really something unusual and from the effect alone ("animation is not running") one cannot find the needed solution.

Closes #18893.

@timhoffm timhoffm added this to the v3.4.0 milestone Nov 4, 2020
@anntzer
Copy link
Contributor

anntzer commented Nov 5, 2020

I guess I will take advantage of this to once again argue that this behavior should be dropped...

@timhoffm
Copy link
Member Author

timhoffm commented Nov 5, 2020

@anntzer Can you point again to the alternative proposal?

@anntzer
Copy link
Contributor

anntzer commented Nov 6, 2020

I think animations should keep themselves alive even with no other references, just like threads do, per #16221 (comment). The implementation can be #16221 or it can be something less magical than hiding strong refs in lambdas; I'm only arguing about the user-observable behavior here (whether animations get gc'ed or not).

@QuLogic
Copy link
Member

QuLogic commented Nov 6, 2020

Well, you can decide that sometime in the future; I'll merge this doc change for now.

@QuLogic QuLogic merged commit 0292396 into matplotlib:master Nov 6, 2020
@timhoffm timhoffm deleted the animation-reference branch November 6, 2020 21:39
@timhoffm
Copy link
Member Author

timhoffm commented Nov 6, 2020

@anntzer oh, I remember. I think we have made our standpoints clear in that discussion. If you want to move this further, I think this needs to be brought to the dev call.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

FuncAnimation only triggered on assignment
3 participants