Skip to content

DOC: Remove long uninstructive examples #28654

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
Aug 5, 2024

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Aug 2, 2024

Remove

@github-actions github-actions bot added the Documentation: examples files in galleries/examples label Aug 2, 2024
- [Hatch filled histogram](https://matplotlib.org/stable/gallery/lines_bars_and_markers/filled_step.html)
  Hatching in histograms is fully supported through matplotlib#28073. This is [now simple](https://matplotlib.org/devdocs/gallery/statistics/histogram_multihist.html#hatch) and does warrant a dedicated example.

- [Percentiles in horizontal bar charts](https://matplotlib.org/stable/gallery/statistics/barchart_demo.html)
  This is a very complex example. But in the end, it's just a bar plot with annotations. While it is statistics-themed through the use of perecntiles, the plot itself has no statistics-related characteristics.
@timhoffm timhoffm force-pushed the doc-remove-examples branch from b8528cd to 6f1bf33 Compare August 3, 2024 06:19
@github-actions github-actions bot added the Documentation: user guide files in galleries/users_explain or doc/users label Aug 3, 2024
@story645
Copy link
Member

story645 commented Aug 4, 2024

Agree on the hatched hist, but could the percentiles one make a decent tutorial if it was reworked or at that point is it basically the lifestyle of plot tutorial?

@timhoffm
Copy link
Member Author

timhoffm commented Aug 4, 2024

I don't see that the percentiles examples is a good basis for a tutorial. In short:

  • It uses various plot elements. They are combined to to achieve a very specific visualization but it's rather a random collection of elements and methods, not a cohesive subset.
  • TBH I find the visualization itself not very good. (Not going into details, because I don't want to start that discussion)

I'd claim, if you have something specific you want to show, you'd be better off with creating a suitable example from scratch.

@story645
Copy link
Member

story645 commented Aug 4, 2024

It uses various plot elements. They are combined to to achieve a very specific visualization but it's rather a random collection of elements and methods, not a cohesive subset.

See, I think that's a plus for a tutorial, but I also do see your point that messaging it into a good tutorial is probably not worth it - I'd probably extend the lifecycle tutorial rather than write new but that's probably the way to go.

@story645 story645 added this to the v3.10.0 milestone Aug 5, 2024
@story645
Copy link
Member

story645 commented Aug 5, 2024

I don't think this is worth backporting?

@story645 story645 merged commit 30cea9d into matplotlib:main Aug 5, 2024
22 checks passed
@timhoffm timhoffm deleted the doc-remove-examples branch August 5, 2024 04:58
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.

2 participants