Description
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:
- Matplotlib interfaces should be reference style documentation
- Quick start should be tutorial style documentation
Topics:
-
From https://matplotlib.org/devdocs/users/explain/quick_start.html#the-explicit-and-the-implicit-interfaces remove
(In addition, there is a third approach, for the case when embedding Matplotlib in a GUI application, which completely drops pyplot, even for figure creation. See the corresponding section in the gallery for more info: Embedding Matplotlib in graphical user interfaces.)
This is an advanced topic and not suited for "Quick Start" -
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.