FIX: review comments

jklymak · jklymak · commit 777b8ef8fc53 · 2022-03-30T10:45:06.000+02:00
diff --git a/lib/matplotlib/_constrained_layout.py b/lib/matplotlib/_constrained_layout.py
@@ -87,6 +87,11 @@ def do_constrained_layout(fig, h_pad, w_pad,
        of 0.1 of the figure width between each column.
        If h/wspace < h/w_pad, then the pads are used instead.
 
+    compress : bool
+        Whether to shift Axes so that white space in between them is
+        removed. This is useful for simple grids of fixed-aspect Axes (e.g.
+        a grid of images).
+
     Returns
     -------
     layoutgrid : private debugging structure
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2357,8 +2357,8 @@ def set_layout_engine(self, layout=None, **kwargs):
         elif layout == 'constrained':
             new_layout_engine = ConstrainedLayoutEngine(**kwargs)
         elif layout == 'compressed':
-            kwargs['compress'] = True
-            new_layout_engine = ConstrainedLayoutEngine(**kwargs)
+            new_layout_engine = ConstrainedLayoutEngine(compress=True,
+                                                        **kwargs)
         elif isinstance(layout, LayoutEngine):
             new_layout_engine = layout
         else:
diff --git a/lib/matplotlib/layout_engine.py b/lib/matplotlib/layout_engine.py
@@ -197,9 +197,9 @@ def __init__(self, *, h_pad=None, w_pad=None,
             Default to :rc:`figure.constrained_layout.hspace` and
             :rc:`figure.constrained_layout.wspace`.
         compress : bool
-            Whether to use compressed layout or not; useful for fixed-aspect
-            simple grids of axes (e.g. a grid of images).  See
-            :ref:`compressed_layout`.
+            Whether to shift Axes so that white space in between them is
+            removed. This is useful for simple grids of fixed-aspect Axes (e.g.
+            a grid of images).  See :ref:`compressed_layout`.
         """
         super().__init__(**kwargs)
         # set the defaults:
diff --git a/tutorials/intermediate/constrainedlayout_guide.py b/tutorials/intermediate/constrainedlayout_guide.py
@@ -400,14 +400,14 @@ def example_plot(ax, fontsize=12, hide_labels=False):
 
 fig = plt.figure()
 gs0 = fig.add_gridspec(1, 2, figure=fig, width_ratios=[1., 2.])
-gsl = gs0[0].subgridspec(2, 1)
-gsr = gs0[1].subgridspec(2, 2)
+gs_left = gs0[0].subgridspec(2, 1)
+gs_right = gs0[1].subgridspec(2, 2)
 
-for gs in gsl:
+for gs in gs_left:
     ax = fig.add_subplot(gs)
     example_plot(ax)
 axs = []
-for gs in gsr:
+for gs in gs_right:
     ax = fig.add_subplot(gs)
     pcm = ax.pcolormesh(arr, **pc_kwargs)
     ax.set_xlabel('x-label')
@@ -456,18 +456,16 @@ def example_plot(ax, fontsize=12, hide_labels=False):
 # Grids of fixed aspect-ratio Axes: "compressed" layout
 # =====================================================
 #
-#
-# By default, ``constrained_layout`` acts on the original position of an axes.
-# However, when Axes have fixed aspect ratios, one side is made shorter.  For
-# a grid of such Axes, this can leave a large gap in the shortened direction.
-# In the following the Axes are square, but the figure quite wide so there is
-# a horizontal gap:
+# ``constrained_layout`` operates on the grid of "original" positions for
+# axes. However, when Axes have fixed aspect ratios, one side is usually made
+# shorter, and leaves large gaps in the shortened direction. In the following,
+# the Axes are square, but the figure quite wide so there is a horizontal gap:
 
 fig, axs = plt.subplots(2, 2, figsize=(5, 3),
                         sharex=True, sharey=True, layout='constrained')
 for ax in axs.flat:
     ax.imshow(arr)
-fig.suptitle('Constrained layout: fixed-aspect plots')
+fig.suptitle("fixed-aspect plots, layout='constrained'")
 
 # One obvious way of fixing this is to make the figure size more square,
 # however, closing the gaps exactly requires trial and error.  For simple grids
@@ -477,7 +475,7 @@ def example_plot(ax, fontsize=12, hide_labels=False):
                         sharex=True, sharey=True, layout='compressed')
 for ax in axs.flat:
     ax.imshow(arr)
-fig.suptitle('Compressed layout: fixed-aspect plots')
+fig.suptitle("fixed-aspect plots, layout='compressed'")
 
 
 ###############################################################################
