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 ee723d9

Browse filesBrowse files
authored
Merge pull request #26329 from anntzer/igd
Clarify that ImageGrid requires limits-sharing.
2 parents fc3ba69 + ae35f41 commit ee723d9
Copy full SHA for ee723d9

File tree

Expand file treeCollapse file tree

1 file changed

+11
-2
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+11
-2
lines changed

‎lib/mpl_toolkits/axes_grid1/axes_grid.py

Copy file name to clipboardExpand all lines: lib/mpl_toolkits/axes_grid1/axes_grid.py
+11-2Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,14 @@ def get_axes_locator(self):
277277

278278

279279
class ImageGrid(Grid):
280-
# docstring inherited
280+
"""
281+
A grid of Axes for Image display.
282+
283+
This class is a specialization of `~.axes_grid1.axes_grid.Grid` for displaying a
284+
grid of images. In particular, it forces all axes in a column to share their x-axis
285+
and all axes in a row to share their y-axis. It further provides helpers to add
286+
colorbars to some or all axes.
287+
"""
281288

282289
def __init__(self, fig,
283290
rect,
@@ -316,7 +323,9 @@ def __init__(self, fig,
316323
Padding or (horizontal padding, vertical padding) between axes, in
317324
inches.
318325
share_all : bool, default: False
319-
Whether all axes share their x- and y-axis.
326+
Whether all axes share their x- and y-axis. Note that in any case,
327+
all axes in a column share their x-axis and all axes in a row share
328+
their y-axis.
320329
aspect : bool, default: True
321330
Whether the axes aspect ratio follows the aspect ratio of the data
322331
limits.

0 commit comments

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