Skip to content

DOC: Remove simple_legend examples from User Demo #29592

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

Merged
merged 1 commit into from
Apr 8, 2025

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Feb 7, 2025

The same plots are contained in the legend guide at

https://matplotlib.org/devdocs/users/explain/axes/legend_guide.html#legend-location
https://matplotlib.org/devdocs/users/explain/axes/legend_guide.html#multiple-legends-on-the-same-axes

And there, they aleady have accompanying descriptions. Instead of moving these examples to the text_labels_and_annotations section, I've decided to remove them and instead link the existing legend examples with a
see also to the legend guide. I believe this is more helpful than having more uncommented legend examples.

This works twoards #25800.

@github-actions github-actions bot added the Documentation: examples files in galleries/examples label Feb 7, 2025
@QuLogic
Copy link
Member

QuLogic commented Feb 24, 2025

Probably some redirects should get added to the legend_guide for the deleted files?

@timhoffm
Copy link
Member Author

Could do, but I question that we need to strictly do this for each and every page. According to plausible these pages were only ~60 times the entry page in the last year. And the redirect would lead to a tutorial instead of the example. Not sure how helpful this is.

The same plots are contained in the legend guide at
https://matplotlib.org/devdocs/users/explain/axes/legend_guide.html#legend-location
https://matplotlib.org/devdocs/users/explain/axes/legend_guide.html#multiple-legends-on-the-same-axes

And there, they aleady have accompanying descriptions. Instead of moving
 these examples to the text_labels_and_annotations section, I've decided
  to remove them and instead link the existing legend examples with a
  see also to the legend guide. I believe this is more helpful than
  having more uncommented legend examples.
@timhoffm timhoffm force-pushed the doc-userdemo-simple_legend branch from 59ee3f3 to a0d5b0a Compare April 8, 2025 15:51
@github-actions github-actions bot added the Documentation: user guide files in galleries/users_explain or doc/users label Apr 8, 2025
@timhoffm
Copy link
Member Author

timhoffm commented Apr 8, 2025

I've added the redirects.

@jklymak jklymak merged commit 1f46d83 into matplotlib:main Apr 8, 2025
22 checks passed
@timhoffm timhoffm deleted the doc-userdemo-simple_legend branch April 8, 2025 17:41
@QuLogic QuLogic added this to the v3.11.0 milestone Apr 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: examples files in galleries/examples Documentation: user guide files in galleries/users_explain or doc/users
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants