-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOC: clarify what we mean by object oriented in pyplot api #21093
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: clarify what we mean by object oriented in pyplot api #21093
Conversation
74ba846
to
8c745e8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is ok as an improvement, and can be merged for 3.5.
However, in the long run, it would be better to improve https://matplotlib.org/devdocs/api/index.html and link there.
I don't have access to the file you are linking. However in general I don't think there is any harm in repeating concepts in a few key places. |
Sorry, I accidentally copied the link from a local doc build. Fixed above. I think mentioning and cross-linking is better than half-touching a topic. It's easier to maintain. And we can keep the focus on the kind of documentation. The pyplot page here is primarily for reference documentation, but the added content is conceptual or maybe how to use. |
We have had significant confusion from folks about statements like "the object oriented API is preferred..." then being confused why we use pyplot in almost every example. This modification guides people to the idea that there are currently two points to the pyplot module. As discussed numerous times, the hope is to disambiguate these two concepts. But in the meantime I think it's helpful to be explicit and include explicit examples of the the two usages. |
1b2de64
to
f9e884d
Compare
a0f51d3
to
de80ee4
Compare
Co-authored-by: Thomas A Caswell <tcaswell@gmail.com>
de80ee4
to
979fe94
Compare
…ented in pyplot api
…093-on-v3.5.x Backport PR #21093 on branch v3.5.x (DOC: clarify what we mean by object oriented in pyplot api)
…riented DOC: clarify what we mean by object oriented in pyplot api
DOC: clarify what we mean by object oriented in pyplot api
PR Summary
Currently: https://matplotlib.org/devdocs/api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot
PR Checklist
pytest
passes).flake8
on changed files to check).flake8-docstrings
and runflake8 --docstring-convention=all
).doc/users/next_whats_new/
(follow instructions in README.rst there).doc/api/next_api_changes/
(follow instructions in README.rst there).