Skip to content

Improve GridSpec doc #13560

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
Mar 1, 2019
+10 −4
Merged

Improve GridSpec doc #13560

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
14 changes: 10 additions & 4 deletions lib/matplotlib/gridspec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,21 +204,27 @@ def __init__(self, nrows, ncols, figure=None,
ncols : int
Number or columns in grid.

figure : ~.figure.Figure, optional
figure : `~.figure.Figure`, optional

left, right, top, bottom : float
left, right, top, bottom : float, optional
Extent of the subplots as a fraction of figure width or height.
Left cannot be larger than right, and bottom cannot be larger than
top.

wspace : float
wspace : float, optional
The amount of width reserved for space between subplots,
expressed as a fraction of the average axis width.

hspace : float
hspace : float, optional
The amount of height reserved for space between subplots,
expressed as a fraction of the average axis height.

width_ratios : length *ncols* iterable, optional
Width ratios of the columns.

height_ratios : length *nrows* iterable, optional
Height ratios of the rows.

Notes
-----
See `~.figure.SubplotParams` for descriptions of the layout parameters.
Expand Down