-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
Expand the explanation of the Object-Oriented interface #18249
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
Comments
Has this issue been resolved ? |
AFAICS partially addressed by #21877. |
@ianhi can we close this, or do you have feedback on #21877 which is now in the devdocs: https://matplotlib.org/devdocs/users/explain/api_interfaces.html#matplotlib-application-interfaces-apis That is just a start and we should continue to refine it. |
@jklymak that looks good! I do think that that should be linked to from various place in the docs. e.g. the pyplot tutorial: https://matplotlib.org/devdocs/tutorials/introductory/pyplot.html#sphx-glr-tutorials-introductory-pyplot-py which still uses the |
Problem
Most of the content of https://matplotlib.org/tutorials/introductory/lifecycle.html#a-note-on-the-object-oriented-api-vs-pyplot will not make sense to a user new matplotlib ( and likely new to python). The text makes several assumptions about the reader:
As a piece of anecdata I was fairly confused by all of this both years ago when I started using matplotlib and more recently when I started to make more complex and interactive matplotlib plots.
Suggested Improvement
Add deeper explanations/definitions for all the above bullet points. As well it would be great to expand on the note that simply says:
with a justification of that claim.
A related example is https://matplotlib.org/gallery/api/agg_oo_sgskip.html which could also use some more explanation or perhaps removal.
The text was updated successfully, but these errors were encountered: