8000 Reword add_subplot docstring. by anntzer · Pull Request #14033 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Reword add_subplot docstring. #14033

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 25, 2019
Merged

Reword add_subplot docstring. #14033

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1281,6 +1281,10 @@ def add_subplot(self, *args, **kwargs):

If no positional arguments are passed, defaults to (1, 1, 1).

In rare circumstances, `.add_subplot` may be called with a single
argument, a subplot axes instance already created in the
present figure but not in the figure's list of axes.

projection : {None, 'aitoff', 'hammer', 'lambert', 'mollweide', \
'polar', 'rectilinear', str}, optional
The projection type of the subplot (`~.axes.Axes`). *str* is the
Expand Down Expand Up @@ -1310,8 +1314,7 @@ def add_subplot(self, *args, **kwargs):

Returns
-------
axes : an `.axes.SubplotBase` subclass of `~.axes.Axes` (or a \
subclass of `~.axes.Axes`)
axes : `.axes.SubplotBase`, or another subclass of `~.axes.Axes`

The axes of the subplot. The returned axes base class depends on
the projection used. It is `~.axes.Axes` if rectilinear projection
Expand All @@ -1330,10 +1333,6 @@ def add_subplot(self, *args, **kwargs):
two subplots that are otherwise identical to be added to the figure,
make sure you give them unique labels.

In rare circumstances, `.add_subplot` may be called with a single
argument, a subplot axes instance already created in the
present figure but not in the figure's list of axes.

See Also
--------
.Figure.add_axes
Expand Down
0