8000 Update subplot2grid doc to use Figure.add_gridspec, not GridSpec. by anntzer · Pull Request #17550 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Update subplot2grid doc to use Figure.add_gridspec, not GridSpec. #17550

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
QuLogic merged 1 commit into from
Jun 5, 2020
Merged

Update subplot2grid doc to use Figure.add_gridspec, not GridSpec. #17550

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
18 changes: 14 additions & 4 deletions lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1295,17 +1295,27 @@ def subplot2grid(shape, loc, rowspan=1, colspan=1, fig=None, **kwargs):
**kwargs
Additional keyword arguments are handed to `add_subplot`.

Returns
-------
an `.axes.SubplotBase` subclass of `~.axes.Axes` (or a 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 is used
and `.projections.polar.PolarAxes` if polar projection is used. The
returned axes is then a subplot subclass of the base class.

Notes
-----
The following call ::

subplot2grid(shape, loc, rowspan=1, colspan=1)
ax = subplot2grid((nrows, ncols), (row, col), rowspan, colspan)

is identical to ::

gridspec = GridSpec(shape[0], shape[1])
subplotspec = gridspec.new_subplotspec(loc, rowspan, colspan)
subplot(subplotspec)
fig = gcf()
gs = fig.add_gridspec(nrows, ncols)
ax = fig.add_subplot(gs[row:row+rowspan, col:col+colspan])
"""

if fig is None:
Expand Down
0