8000 changed tight_layout doc strings · matplotlib/matplotlib@f84bcb0 · GitHub
[go: up one dir, main page]

Skip to content

Commit f84bcb0

Browse files
committed
changed tight_layout doc strings
1 parent 90437e4 commit f84bcb0

File tree

2 files changed

+14
-16
lines changed

2 files changed

+14
-16
lines changed

lib/matplotlib/figure.py

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2066,20 +2066,18 @@ def execute_constrained_layout(self, renderer=None):
20662066
def tight_layout(self, renderer=None, pad=1.08, h_pad=None, w_pad=None,
20672067
rect=None):
20682068
"""
2069-
Adjust subplot parameters to give specified padding.
2069+
Automatically adjust subplot parameters to give specified padding.
20702070
20712071
Parameters
20722072
----------
20732073
pad : float
2074-
padding between the figure edge and the edges of subplots,
2075-
as a fraction of the font-size.
2076-
2077-
h_pad, w_pad : float, optional
2078-
padding (height/width) between edges of adjacent subplots.
2079-
Defaults to `pad_inches`.
2080-
2074+
Padding between the figure edge and the edges of subplots,
2075+
as a fraction of the font size.
2076+
h_pad, w_pad : float
2077+
Padding (height/width) between edges of adjacent subplots,
2078+
as a fraction of the font size. Defaults to *pad*.
20812079
rect : tuple (left, bottom, right, top), optional
2082-
a rectangle (left, bottom, right, top) in the normalized
2080+
A rectangle (left, bottom, right, top) in the normalized
20832081
figure coordinate that the whole subplots area (including
20842082
labels) will fit into. Default is (0, 0, 1, 1).
20852083
"""

lib/matplotlib/pyplot.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1256,15 +1256,15 @@ def tight_layout(pad=1.08, h_pad=None, w_pad=None, rect=None):
12561256
Parameters
12571257
----------
12581258
pad : float
1259-
padding between the figure edge and the edges of subplots, as a fraction of the font-size.
1259+
Padding between the figure edge and the edges of subplots,
1260+
as a fraction of the font size.
12601261
h_pad, w_pad : float
1261-
padding (height/width) between edges of adjacent subplots.
1262-
Defaults to `pad_inches`.
1263-
rect : if rect is given, it is interpreted as a rectangle
1264-
(left, bottom, right, top) in the normalized figure
1265-
coordinate that the whole subplots area (including
1262+
Padding (height/width) between edges of adjacent subplots,
1263+
as a fraction of the font size. Defaults to *pad*.
1264+
rect : tuple (left, bottom, right, top), optional
1265+
A rectangle (left, bottom, right, top) in the normalized
1266+
figure coordinate that the whole subplots area (including
12661267
labels) will fit into. Default is (0, 0, 1, 1).
1267-
12681268
"""
12691269
fig = gcf()
12701270
fig.tight_layout(pad=pad, h_pad=h_pad, w_pad=w_pad, rect=rect)

0 commit comments

Comments
 (0)
0