Skip to content
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

DOC: Rewrite the example illustrating bxp() #27965

Merged
merged 1 commit into from
Mar 23, 2024

Conversation

timhoffm
Copy link
Member

Previously, the example essentially replicated illustrations of a lot of styling variants, which have already been shown for boxplot(). Compare:

I believe it's not necessary to iterate through all that again. Instead, this rewrite focuses on the relation between boxplot_stats(), bxp() and boxplot. And it shows how to use bxp() in isolation.

@github-actions github-actions bot added the Documentation: examples files in galleries/examples label Mar 22, 2024
Copy link
Member

@rcomer rcomer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When boxplot_stats was introduced, one of the stated advantages mentioned in the whatsnew is that you can modify its output dictionaries before passing them to bxp. Is it worth mentioning that here too, or is that an obvious exercise for the reader?

In general, 👍 to this change.

galleries/examples/statistics/bxp.py Outdated Show resolved Hide resolved
Previously, the example essentially replicated illustrations of a lot
of styling variants, which have already been shown for `boxplot()`.
Compare:
- https://matplotlib.org/3.8.3/gallery/statistics/bxp.html
- https://matplotlib.org/3.8.3/gallery/statistics/boxplot.html

I believe it's not necessary to iterate through all that again. Instead,
this rewrite focuses on the relation between `boxplot_stats()`, `bxp()`
and `boxplot`. And it shows how to use `bxp()` in isolation.
@timhoffm
Copy link
Member Author

@rcomer I would skip mentioning that you can modify the output of boxplot_stats(). First, it's quite obvious that you can manipulate dicts. Second, I don't see a real-world use case in which you would manipulate the statistics.

@rcomer rcomer added this to the v3.9.0 milestone Mar 23, 2024
@rcomer rcomer merged commit 0d59664 into matplotlib:main Mar 23, 2024
22 checks passed
@timhoffm timhoffm deleted the bxp-example branch March 23, 2024 14:30
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants