Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 6a84a5d

Browse filesBrowse files
authored
Merge pull request #29254 from timhoffm/doc-align-labels
DOC: Add note to align_labels()
2 parents 5f61b10 + 07c2f3f commit 6a84a5d
Copy full SHA for 6a84a5d

File tree

1 file changed

+11
-6
lines changed
Filter options

1 file changed

+11
-6
lines changed

‎lib/matplotlib/figure.py

Copy file name to clipboardExpand all lines: lib/matplotlib/figure.py
+11-6Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1382,8 +1382,8 @@ def align_xlabels(self, axs=None):
13821382
13831383
Notes
13841384
-----
1385-
This assumes that ``axs`` are from the same `.GridSpec`, so that
1386-
their `.SubplotSpec` positions correspond to figure positions.
1385+
This assumes that all Axes in ``axs`` are from the same `.GridSpec`,
1386+
so that their `.SubplotSpec` positions correspond to figure positions.
13871387
13881388
Examples
13891389
--------
@@ -1444,8 +1444,8 @@ def align_ylabels(self, axs=None):
14441444
14451445
Notes
14461446
-----
1447-
This assumes that ``axs`` are from the same `.GridSpec`, so that
1448-
their `.SubplotSpec` positions correspond to figure positions.
1447+
This assumes that all Axes in ``axs`` are from the same `.GridSpec`,
1448+
so that their `.SubplotSpec` positions correspond to figure positions.
14491449
14501450
Examples
14511451
--------
@@ -1500,8 +1500,8 @@ def align_titles(self, axs=None):
15001500
15011501
Notes
15021502
-----
1503-
This assumes that ``axs`` are from the same `.GridSpec`, so that
1504-
their `.SubplotSpec` positions correspond to figure positions.
1503+
This assumes that all Axes in ``axs`` are from the same `.GridSpec`,
1504+
so that their `.SubplotSpec` positions correspond to figure positions.
15051505
15061506
Examples
15071507
--------
@@ -1544,6 +1544,11 @@ def align_labels(self, axs=None):
15441544
matplotlib.figure.Figure.align_xlabels
15451545
matplotlib.figure.Figure.align_ylabels
15461546
matplotlib.figure.Figure.align_titles
1547+
1548+
Notes
1549+
-----
1550+
This assumes that all Axes in ``axs`` are from the same `.GridSpec`,
1551+
so that their `.SubplotSpec` positions correspond to figure positions.
15471552
"""
15481553
self.align_xlabels(axs=axs)
15491554
self.align_ylabels(axs=axs)

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.