8000 Clarify wspace/hspace in documentation/comments · matplotlib/matplotlib@0507459 · GitHub
[go: up one dir, main page]
Skip to content

Commit 0507459

Browse files
stilley2stilley2
committed
Clarify wspace/hspace in documentation/comments
1 parent 3096a83 commit 0507459

File tree

5 files changed

+20
-10
lines changed

5 files changed

+20
-10
lines changed

‎doc/faq/howto_faq.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,9 +176,11 @@ The other parameters you can configure are, with their defaults
176176
*top* = 0.9
177177
the top of the subplots of the figure
178178
*wspace* = 0.2
179-
the amount of width reserved for blank space between subplots
179+
the amount of width reserved for blank space between subplots,
180+
expressed as a fraction of the average axis width
180181
*hspace* = 0.2
181-
the amount of height reserved for white space between subplots
182+
the amount of height reserved for white space between subplots,
183+
expressed as a fraction of the average axis height
182184

183185
If you want additional control, you can create an
184186
:class:`~matplotlib.axes.Axes` using the

‎lib/matplotlib/figure.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,10 +182,12 @@ def __init__(self, left=None, bottom=None, right=None, top=None,
182182
The top of the subplots of the figure
183183
184184
*wspace* : 0.2
185-
The amount of width reserved for blank space between subplots
185+
The amount of width reserved for blank space between subplots,
186+
expressed as a fraction of the average axis width
186187
187188
*hspace* : 0.2
188-
The amount of height reserved for white space between subplots
189+
The amount of height reserved for white space between subplots,
190+
expressed as a fraction of the average axis height
189191
"""
190192

191193
self.validate = True

‎lib/matplotlib/mpl-data/stylelib/classic.mplstyle

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,8 +316,10 @@ figure.subplot.left : 0.125 # the left side of the subplots of the figure
316316
figure.subplot.right : 0.9 # the right side of the subplots of the figure
317317
figure.subplot.bottom : 0.1 # the bottom of the subplots of the figure
318318
figure.subplot.top : 0.9 # the top of the subplots of the figure
319-
figure.subplot.wspace : 0.2 # the amount of width reserved for blank space between subplots
320-
figure.subplot.hspace : 0.2 # the amount of height reserved for white space between subplots
319+
figure.subplot.wspace : 0.2 # the amount of width reserved for blank space between subplots,
320+
# expressed as a fraction of the average axis width
321+
figure.subplot.hspace : 0.2 # the amount of height reserved for white space between subplots,
322+
# expressed as a fraction of the average axis height
321323

322324
### IMAGES
323325
image.aspect : equal # equal | auto | a number

‎lib/matplotlib/pyplot.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1242,8 +1242,10 @@ def subplots_adjust(*args, **kwargs):
12421242
right = 0.9 # the right side of the subplots of the figure
12431243
bottom = 0.1 # the bottom of the subplots of the figure
12441244
top = 0.9 # the top of the subplots of the figure
1245-
wspace = 0.2 # the amount of width reserved for blank space between subplots
1246-
hspace = 0.2 # the amount of height reserved for white space between subplots
1245+
wspace = 0.2 # the amount of width reserved for blank space between subplots,
1246+
# expressed as a fraction of the average axis width
1247+
hspace = 0.2 # the amount of height reserved for white space between subplots,
1248+
# expressed as a fraction of the average axis height
12471249
12481250
The actual defaults are controlled by the rc file
12491251
"""

‎matplotlibrc.template

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -449,8 +449,10 @@ backend : $TEMPLATE_BACKEND
449449
#figure.subplot.right : 0.9 # the right side of the subplots of the figure
450450
#figure.subplot.bottom : 0.11 # the bottom of the subplots of the figure
451451
#figure.subplot.top : 0.88 # the top of the subplots of the figure
452-
#figure.subplot.wspace : 0.2 # the amount of width reserved for blank space between subplots
453-
#figure.subplot.hspace : 0.2 # the amount of height reserved for white space between subplots
452+
#figure.subplot.wspace : 0.2 # the amount of width reserved for blank space between subplots,
453+
# expressed as a fraction of the average axis width
454+
#figure.subplot.hspace : 0.2 # the amount of height reserved for white space between subplots,
455+
# expressed as a fraction of the average axis height
454456

455457

456458
### IMAGES

0 commit comments

Comments
 (0)
0