Update annotate_explain.py #25674
Update annotate_explain.py #25674
Conversation
Add more explanatory comments to annotate_explain.py example for enhanced readability.
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.
|
Thanks for you contribution! However, I don't think this is going the right direction. I know, our current description how examples should look like is insufficient. Please read #11654 (comment) to get a general idea. |
|
Hi @timhoffm , thank you for the reply. I looked at the link you provided. Could you please add some suggestion in this PR to improve. That will be much more easier for me to understand what else is needed. |
This PR definitely clutters the code. The original issue refers to the fact that many of the examples were just an example, with no preamble explaining the goal of the example, or what feature it is being demonstrated. Most of these have been fixed, but if you look through the examples there are still a few that haven't been updated eg https://matplotlib.org/stable/gallery/subplots_axes_and_figures/axes_zoom_effect.html |
|
Hi @ggold7046 👋🏻 Let me know if you'd like to connect some time! Maybe we can chat either on gitter (where you can also join our #incubator channel) or through a zoom call and discuss possible ways to contribute. I'd be happy to know more about your goals and how we can best support you. Cheers! |
|
Um to maybe complicate things a bit further, but getting this out b/f more work is done here, I think this example should be incorporated into the annotation tutorial. Arguably, I don't think this section of the gallery even makes sense anymore given it mostly acted as a place to store tutorial images, and most of the images should either be rehomed to their tutorials or to a more semantically meaningful location in the gallery. This example in particular is generating a reference image to illustrate a feature of annotations, but isn't particularly written in a way where I think it's good at teaching someone how to use the feature. For that, I'd advocate adding a small example to https://matplotlib.org/devdocs/users/explain/text/annotations.html#customizing-annotation-arrows |
|
Converting to draft pending revision |
Add more explanatory comments to annotate_explain.py example for enhanced readability.
PR Summary
This Pull Request improves the documentation of the annotate_explain.py example.
Adds enough information in the example file for the user to understand every step
PR Checklist
Documentation and Tests
pytestpasses)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