Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 8029382

Browse files
jklymaktimhoffm
andauthored
Apply suggestions from code review
Co-authored-by: Tim Hoffmann <[email protected]>
1 parent 3c9d40b commit 8029382

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

doc/api/index.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,21 @@ API
88

99
For recent changes, see :doc:`api_changes`.
1010

11-
Much of the library is accessed by creating :doc:`Figure <figure_api>`
12-
and :doc:`Axes <axes_api>` objects and calling methods on them.
11+
When using the library you will typically create
12+
:doc:`Figure <figure_api>` and :doc:`Axes <axes_api>` objects and
13+
call their methods to add content and modify the apprearance.
1314

14-
- :doc:`figure_api`: axes creation, figure-level artists
15-
- :doc:`axes_api`: most plotting methods, axes labels, access to
15+
- :doc:`figure_api`: axes creation, figure-level content
16+
- :doc:`axes_api`: most plotting methods, Axes labels, access to
1617
axis styling, etc.
1718

1819

1920
(Note that there is also a parallel `matplotlib.pyplot` API interface
2021
that is considered useful for interactive work; see
2122
:ref:`usage patterns <usage_patterns>`, below).
2223

23-
Simple example: the ``ax`` object has an `.axes.Axes.plot` method
24-
that is used to create the line plot.
24+
Example: We create a Figure ``fig`` and Axes ``ax``. Then we call
25+
methods on them to plot data, add axis labels and a figure title.
2526

2627
.. plot::
2728
:include-source:
@@ -43,7 +44,7 @@ that is used to create the line plot.
4344
Modules
4445
-------
4546

46-
Alphabetical list of all submodules:
47+
Alphabetical list of submodules:
4748

4849
.. toctree::
4950
:maxdepth: 1
@@ -141,7 +142,7 @@ Below we describe several common approaches to plotting with Matplotlib.
141142
The pyplot API
142143
^^^^^^^^^^^^^^
143144

144-
`matplotlib.pyplot` is a collection of command style functions that make
145+
`matplotlib.pyplot` is a collection of functions that make
145146
Matplotlib work like MATLAB. Each pyplot function makes some change to a
146147
figure: e.g., creates a figure, creates a plotting area in a figure, plots
147148
some lines in a plotting area, decorates the plot with labels, etc.

0 commit comments

Comments
 (0)