Skip to content

Add note on keeping a reference to animation docstrings - #18896

Merged
QuLogic merged 1 commit into
matplotlib:masterfrom
timhoffm:animation-reference
Nov 6, 2020
Merged

QuLogic merged 1 commit into
matplotlib:masterfrom
timhoffm:animation-reference

Conversation

@timhoffm

@timhoffm timhoffm commented Nov 4, 2020

Copy link
Copy Markdown
Member

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

anntzer commented Nov 5, 2020

Copy link
Copy Markdown
Contributor

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

@timhoffm

timhoffm commented Nov 5, 2020

Copy link
Copy Markdown
Member Author

@anntzer Can you point again to the alternative proposal?

@anntzer

anntzer commented Nov 6, 2020 •

Copy link
Copy Markdown
Contributor

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

QuLogic commented Nov 6, 2020

Copy link
Copy Markdown
Member

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

timhoffm commented Nov 6, 2020

Copy link
Copy Markdown
Member Author

@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