8000 adding pyplot API context · matplotlib/matplotlib@edf2cf8 · GitHub
[go: up one dir, main page]

Skip to content

Commit edf2cf8

Browse files
committed
adding pyplot API context
1 parent 0a58484 commit edf2cf8

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

doc/api/pyplot_summary.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
Plotting commands summary
22
=========================
33

4+
The :mod:`matplotlib.pyplot` module contains functions that allow you to generate
5+
many kinds of plots quickly. For examples that showcase the use
6+
of the :mod:`matplotlib.pyplot` module, see the
7+
:ref:`sphx_glr_tutorials_01_introductory_pyplot.py`
8+
or the :ref:`pyplots_examples`.
9+
10+
The Object-Oriented API
11+
-----------------------
12+
Most of these functions also exist as methods in the
13+
:class:`matplotlib.axes.Axes` class. You can use them with the
14+
so-called "Object Oriented" approach to Matplotlib.
15+
16+
While it is easy to quickly generate plots with the
17+
:mod:`matplotlib.pyplot` module,
18+
we recommend using the object-oriented approach for more control
19+
and customization of your plots. For some examples of the OO approach
20+
to Matplotlib, see the :ref:`api_examples` examples.
21+
22+
The Pyplot API
23+
--------------
24+
425
.. currentmodule:: matplotlib.pyplot
526

627
.. autofunction:: plotting

doc/contents.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Overview
1515
:maxdepth: 2
1616

1717
users/index.rst
18-
api/index.rst
1918
faq/index.rst
2019
mpl_toolkits/index.rst
2120
resources/index.rst
2221
thirdpartypackages/index.rst
22+
api/index.rst
2323
devel/index.rst
2424
glossary/index.rst
2525

0 commit comments

Comments
 (0)
0