-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
[DOC]: Add simple animation scatter plot to the example documentation #24096
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
dde1897
to
f4fe3e1
Compare
Looks good to me but @anntzer does the pillow stuff need to be commented out? |
I actually find this a bit confusing. If the pillow stuff is commented out, why not just add the comments to an existing example |
I think seperately I'd really like a simple dot example since the rain scatter has kind of a lot going on in it. |
Adding the instructions commented out to a simple preexisting example, e.g. https://matplotlib.org/devdocs/gallery/animation/simple_anim.html, seems fine to me, but an important point is that the title of the example should make it clear that saving as gif is showcased by that example (you don't want the user to click through all animation examples until finding out which one explains how to save as gif). |
Agreed. We can make the title more informative, if we go down the road of using this animation to illustrate saving as a gif. But before I make any changes, awaiting confirmation that we want to do this instead of just adding it to another example. |
My bias is that I think this example would be useful and a title like "Scatter Animation Saved as Gif" would keep all the relevant bits. I'm not opposed to adding saving to an existing example instead, but one where a) adding to the title won't detract from the title b)the example isn't so complex that the the saving will get buried. |
Sorry, I don't have the bandwidth to look more into this right now. |
I'll approve if you change the title to "Animated Scatter Saved as Gif" but I don't know if anyone else will (though I don't think that's a blocker unless somebody explicitly blocks). |
Done |
We use sentence case, not title case, don't we? ➡ "Animated scatter saved as GIF" (but either way GIF should be capitalized as an acronym.) |
🤦♀️yeah, sorry forgot! @kostyafarber please switch to sentence case. |
@story645 done! |
d9f7f77
to
7424ce3
Compare
@kostyafarber let me know if I should merge and then a follow up is making this the saving all the things example or if you'll update this as a saving all the things example. |
Hey let's just merge it and we can do a follow up PR. Thanks |
…t to the example documentation
Something went wrong ... Please have a look at my logs. It seems that the branch you are trying to backport to does not exist. |
…096-on-v3.6.x Backport PR #24096 on branch v3.6.x ([DOC]: Add simple animation scatter plot to the example documentation)
…matplotlib#24096) * add simple animation scatter plot * change title to Animated Scatter Saved as Gif * change title to sentence case
PR Summary
This example comes off the back of #22374, the purpose being to provide a simple example of how to use
PillowWriter
to save an animation as a gif.PR Checklist
Tests and Styling
flake8-docstrings
and runflake8 --docstring-convention=all
).Documentation