Skip to content

Remove the examples category "Our Favorite Recipies" #18300

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

Closed
timhoffm opened this issue Aug 19, 2020 · 4 comments · Fixed by #18323
Closed

Remove the examples category "Our Favorite Recipies" #18300

timhoffm opened this issue Aug 19, 2020 · 4 comments · Fixed by #18323
Milestone

Comments

@timhoffm
Copy link
Member

https://matplotlib.org/devdocs/gallery/index.html#our-favorite-recipes

"Favorite" is very subjective. And to me this is just a random selection, nothing particularly intriguing or noteworthy.

The examples from this category should either be removed (if redunant) or moved to other sections.

@diegopetrola
Copy link
Contributor

diegopetrola commented Aug 20, 2020

I looked around the gallery for a bit, here's what I propose to be done with out favorite recipes:

  • The Placing text boxes is almost identical to the Pyplot text, the only difference is that the former uses a bbox and the second doesn't. I suggest merging the two together (even a deletion can be considered, there are a lot of box examples already).

  • The Common Date Problems is almost identical to Formatting date ticks using ConciseDateFormatter. The latter is a little more verbose but it introduces the ConciseDateFormatter. I believe Common Date Problems can be deleted.

  • Centered Spines With Arrows is almost identical to Spine Placement Demo. The only difference is that the first one implements arrow tips. For the sake of making the examples more distinguishable (some users might want to learn just how to make arrow tips) I suggest keeping both and moving Centered Spine With Arrows to the Ticks and Spines section.

  • Sharing Axis Limits and Views is identical to Shared Axis Demo and the latter is more detailed. I suggest deleting Sharing Axis Limits and Views.

  • Fill Between Alpha is a tough call for me. The example is big (3 examples in one html page) but it's well explained and it covers some interesting math topics like random walks which makes for a good read overall, OTOH, there are at least 6 other fill examples that do more or less the same. I suggest moving to either Miscellaneous or Lines, bars and markers section, but a deletion could be considered.

I could start the implementations, but, if possible, I would like to know what someone more experienced think of this suggestions before starting.

@story645
Copy link
Member

  • placing text labels is using OO while pyplot is using pyplot so I don't know about merging the two interfaces, is there an OO example if can be merged into? (xref: Pyplot gallery section is mostly OO examples #15922 'cause part of the issue is that the pyplot section is inconsistent)
  • slightly conflicted b/c this is more general than conciseDateFormatter, but ConciseDateFormatter probably fixes the problem for most people (see Create Date Formatter/Locator Reference #17283)
  • agree with our suggestion for moving that example
  • this is another pyplot/OO problem, agree on deletion but than either sharedAxisDemo should be updated to be more OO or a pure OO example should be spun up to replace Sharing Axis Limits and Views (& possibly use https://matplotlib.org/3.3.1/users/whats_new.html#new-axes-sharex-axes-sharey-methods)
  • agree on moving to lines, bars, and markers with the rest of the fill_between demos and leave consolidation of those demos to someone else.

@timhoffm
Copy link
Member Author

I'd more "Placing text boxes" as is to the section "Text, labels, and annotations". What to do about the pyplot section is a separate topic.

Agreed with everything else.

@diegopetrola
Copy link
Contributor

Thx everyone for your inputs, I will start working.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants