DOC: add example of spinning circle icon animation #24448
Conversation
Co-authored-by: Thomas A Caswell <tcaswell@gmail.com>
|
Can you advocate for this a bit more? What new does this bring to the already existing examples? Thanks! |
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
|
xref #24274 Thank you for your work on this @joAschauer ! In general our documentation suffers from both the problem that we do not have enough (there are things that should be documented that are not) and too much (it is hard to actually find the thing you need!). While this is very cool example, why do you think this helps the first problem (not enough docs) without making the second worse (too much docs)? I'm a bit worried about the multipdf failures... |
|
I did not find a combination of Axes.vlines and polar projection in the documentation. Maybe good to show this somewhere, although it is already answered on stackoverflow (https://stackoverflow.com/a/36828129). If you think this does not add enough value and rather clutters the examples, feel free to close the PR. |
|
Maybe better to make a proper animation tutorial (#24274) than adding more and more examples. I leave it up to you if this should be included or not. |
|
@joAschauer Thanks a lot for this. OTOH, I'm not clear why it is an animation, nor particularly why the static demonstration is needed. I don't think we need every plotting method repeated in polar co-ordinates, and adding vlines doesn't seem particularly complicated? But likely I am missing a subtlety? |
|
Moved to draft until we get more explanation. |
|
Hi @jklymak and sorry for the late reply. You are right, adding vlines to a polar plot is not complicated, but I personally like to learn from examples. Sometimes I wonder how something would be done in matplotlib and I play around. The same was true for the spinning circles waiting icon on my phone, which is animated. Since I liked the result, I thought it could be shared with others and opened this PR. As I feel you think it goes beyond the scope of the examples and doesn't add enough value, I am going to close this pull request. |
|
Perhaps it would be good in the showcase at https://discourse.matplotib.org? Our example library is very large, so we need to be somewhat selective in choosing what to add. Thanks for your understanding. |
PR Summary
Adds an example to the animations section showing an animated spinning circle loading icon.
Documentation failed to build locally due to some latex error in the example
misc/multipage_pdf.py. The added example is working when run individually.PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst