Skip to content

Commit

Permalink
Merge pull request matplotlib#26329 from anntzer/igd
Browse files Browse the repository at this point in the history
Clarify that ImageGrid requires limits-sharing.
  • Loading branch information
tacaswell authored Jul 19, 2023
2 parents fc3ba69 + ae35f41 commit ee723d9
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions lib/mpl_toolkits/axes_grid1/axes_grid.py
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,14 @@ def get_axes_locator(self):


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

def __init__(self, fig,
rect,
Expand Down Expand Up @@ -316,7 +323,9 @@ def __init__(self, fig,
Padding or (horizontal padding, vertical padding) between axes, in
inches.
share_all : bool, default: False
Whether all axes share their x- and y-axis.
Whether all axes share their x- and y-axis. Note that in any case,
all axes in a column share their x-axis and all axes in a row share
their y-axis.
aspect : bool, default: True
Whether the axes aspect ratio follows the aspect ratio of the data
limits.
Expand Down

0 comments on commit ee723d9

Please sign in to comment.