-
-
Notifications
You must be signed in to change notification settings - Fork 8k
Slim down animation examples in the gallery #22007
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
Conversation
6ceefa5
to
eeef7cf
Compare
I dunno if it's a pro or con that the double pendulum & rain examples are all over the internet - a follow up might be to move these to the blog?
These also produce large output (I think unchained is actually the worst in that regard).
I would rather see the length of the animations cut down or skipped on CI (which might require work against sphinx-gallery) so save time rather than cutting them all together. I think there is a lot of value in a pretty complete application that, even though it does not show anything unique, shows how to put them together. That bit of "oooh, you can assemble the pieces like that...." spark should not be discounted.
Does this need discussion @dstansby, or do you have enough to work on? I'm putting back to draft given the comments above, but feel free to put back int he active queue. Thanks!
Thanks - I think there's enough to go on when I come back round to looking at this 👍
Since it seems like this requires higher level discussion beyond a quick PR, I'm going to close.
PR Summary
This removes three animation examples from the gallery that between them take ~ 1.5 minutes to run in the doc build, but do not demonstrate Matplotlib concepts/functionality that isn't in other examples. In my opinion they are nice to have, but saving 1.5 mins on each doc CI run is a worthwhile saving. I'm probably +0.5 on it though, so if someone is keen that they stay very happy for this to be closed without merging.
Also some other minor PEP8 fixes.
PR Checklist
Tests and Styling
pytest
passes).flake8-docstrings
and runflake8 --docstring-convention=all
).Documentation
doc/users/next_whats_new/
(follow instructions in README.rst there).doc/api/next_api_changes/
(follow instructions in README.rst there).