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

Skip to content

Commit a54c47f

Browse files
committed
DOC: simplify figure_api.rst
1 parent 584a6a2 commit a54c47f

File tree

3 files changed

+8
-30
lines changed

3 files changed

+8
-30
lines changed

doc/api/figure_api.rst

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,6 @@
55
.. currentmodule:: matplotlib.figure
66

77
.. automodule:: matplotlib.figure
8-
:no-members:
9-
:no-inherited-members:
10-
11-
Classes
12-
-------
13-
14-
.. autosummary::
15-
:toctree: _as_gen/
16-
:template: autosummary.rst
17-
:nosignatures:
18-
19-
PanelBase
20-
SubPanel
21-
Figure
22-
SubplotParams
23-
24-
Functions
25-
---------
26-
27-
.. autosummary::
28-
:toctree: _as_gen/
29-
:template: autosummary.rst
30-
:nosignatures:
31-
32-
figaspect
8+
:members:
9+
:inherited-members:
10+
:exclude-members: AxesStack

lib/matplotlib/figure.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
Many methods are implimented in `PanelBase`.
77
88
`SubPanel`
9-
A logical figure inside a figure, usually added to a figure or parent
10-
`SubPanel` with `.add_subpanel` or `.subpanels` methods (provisional
11-
API v3.4).
9+
A logical figure inside a figure, usually added to a figure (or parent
10+
`SubPanel`) with `Figure.add_subpanel` or `Figure.subpanels` methods
11+
(provisional API v3.4).
1212
1313
`SubplotParams`
1414
Control the default spacing between subplots.
@@ -1434,7 +1434,7 @@ def subpanels(self, nrows=1, ncols=1, squeeze=True,
14341434
The amount of width/height reserved for space between subpanels,
14351435
expressed as a fraction of the average subpanel width.
14361436
If not given, the values will be inferred from a figure or
1437-
rcParams when necessary. See also `GridSpec.get_subplot_params`.
1437+
rcParams when necessary.
14381438
14391439
width_ratios : array-like of length *ncols*, optional
14401440
Defines the relative widths of the columns. Each column gets a

lib/matplotlib/pyplot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1159,7 +1159,7 @@ def subplot(*args, **kwargs):
11591159
two subplots that are otherwise identical to be added to the figure,
11601160
make sure you give them unique labels.
11611161
1162-
In rare circumstances, `.add_subplot` may be called with a single
1162+
In rare circumstances, `Figure.add_subplot` may be called with a single
11631163
argument, a subplot axes instance already created in the
11641164
present figure but not in the figure's list of axes.
11651165

0 commit comments

Comments
 (0)