-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
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]: Improvements /sorting content for Quickstart Guide / Matplotlib Application Interfaces #29282
Comments
I was thinking explain style, but structured kinda around visual variables: I go back and forth on aesthetic first or mark type first, but I think having a consistent ordering/structure would make it a lot easier to build associations between "this artist class (and therefore these plot types) supports these visual stylings/parameters" |
Maybe that's the fundamental question we should clarify first. I see "Quick start" as the entry point for new users (similar to 10 minutes to pandas). The goal is that users can get productive and do their first plots relatively quickly. Do we agree so far? Coming from https://docs.divio.com/documentation-system/
IMHO the focus should be on learning. Of course, they have to understand some concepts, but only as far as is needed to get a plot done. From https://docs.divio.com/documentation-system/explanation/:
And that's not the goal of a quick start. |
The quick start is definitely a tutorial. However even tutorials need to occasionally have some explanation if it is something that trips up many users at the beginning. I think what happened here was the initial explanation of the difference between the interfaces was in the Quick Start, and then it got expanded because it was not explained anywhere else. Now that we have a more complete Users Guide, making this section of the Quick Start more concise with links for further explanation deeper into the UG makes good sense. |
Documentation Link
https://matplotlib.org/devdocs/users/explain/figure/api_interfaces.html
https://matplotlib.org/devdocs/users/explain/quick_start.html
Problem
Follow up with ideas discussed in #29272
Suggested improvement
Motivation:
Topics:
From https://matplotlib.org/devdocs/users/explain/quick_start.html#the-explicit-and-the-implicit-interfaces remove
Instead create a dedicated section in https://matplotlib.org/devdocs/users/explain/figure/api_interfaces.html, also include DOC: Add section on translating between Axes and pyplot interface #29272 (comment)
Rethink whether we can make https://matplotlib.org/devdocs/users/explain/quick_start.html#coding-styles more approachable. - Instead of just stating the two styles with (relatively complex) examples, give a brief guidance (Quick start should be tutorial-style not reference-style).
Optionally: https://matplotlib.org/devdocs/users/explain/figure/api_interfaces.html#third-party-library-data-object-interfaces could be expanded to explain how pandas plots work, i.e. every plot function creates a new Figure and Axes unless an Axes is passed in. As with
pyplot
, this does not require an explicit Axes, but the implicit behavior is different (new Axes vs. reuse current Axes). While strictly not our responsibility, this addition may be helpful.The text was updated successfully, but these errors were encountered: