Expire deprecation of AxesDivider defaulting to zero pads.

anntzer · anntzer · commit 8038f55e612d · 2021-04-24T23:39:12.000+02:00
Note that the semantics of the rcParams are *relative* sizes, so they
should be interpreted as such here too.
diff --git a/doc/api/next_api_changes/behavior/20064-AL.rst b/doc/api/next_api_changes/behavior/20064-AL.rst
@@ -0,0 +1,5 @@
+``AxesDivider`` now defaults to rcParams-specified pads
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+`.AxesDivider.append_axes`, `.AxesDivider.new_horizontal`, and
+`.AxesDivider.new_vertical` now default to paddings specified by
+:rc:`figure.subplot.wspace` and :rc:`figure.subplot.hspace` rather than zero.
diff --git a/lib/mpl_toolkits/axes_grid1/axes_divider.py b/lib/mpl_toolkits/axes_grid1/axes_divider.py
@@ -4,6 +4,7 @@
 
 import numpy as np
 
+import matplotlib as mpl
 from matplotlib import _api
 from matplotlib.axes import SubplotBase
 from matplotlib.gridspec import SubplotSpec, GridSpec
@@ -434,11 +435,12 @@ def new_horizontal(self, size, pad=None, pack_start=False, **kwargs):
         Parameters
         ----------
         size : :mod:`~mpl_toolkits.axes_grid1.axes_size` or float or str
-            A width of the axes. If float or string is given, *from_any*
-            function is used to create the size, with *ref_size* set to AxesX
-            instance of the current axes.
+            The axes width.  float or str arguments are interpreted as
+            ``axes_size.from_any(size, AxesX(self))``.
         pad : :mod:`~mpl_toolkits.axes_grid1.axes_size` or float or str
-            Pad between the axes. It takes same argument as *size*.
+            Padding between the axes.  float or str arguments are interpreted
+            as ``axes_size.from_any(size, AxesX(self))``.  Defaults to
+            :rc:`figure.subplot.wspace` times the current axes width.
         pack_start : bool
             If False, the new axes is appended at the end
             of the list, i.e., it became the right-most axes. If True, it is
@@ -450,10 +452,7 @@ def new_horizontal(self, size, pad=None, pack_start=False, **kwargs):
             main axes will be used.
         """
         if pad is None:
-            _api.warn_deprecated(
-                "3.2", message="In a future version, 'pad' will default to "
-                "rcParams['figure.subplot.wspace'].  Set pad=0 to keep the "
-                "old behavior.")
+            pad = mpl.rcParams["figure.subplot.wspace"] * self._xref
         if pad:
             if not isinstance(pad, Size._Base):
                 pad = Size.from_any(pad, fraction_ref=self._xref)
@@ -483,11 +482,12 @@ def new_vertical(self, size, pad=None, pack_start=False, **kwargs):
         Parameters
         ----------
         size : :mod:`~mpl_toolkits.axes_grid1.axes_size` or float or str
-            A height of the axes. If float or string is given, *from_any*
-            function is used to create the size, with *ref_size* set to AxesX
-            instance of the current axes.
+            The axes height.  float or str arguments are interpreted as
+            ``axes_size.from_any(size, AxesY(self))``.
         pad : :mod:`~mpl_toolkits.axes_grid1.axes_size` or float or str
-            Pad between the axes. It takes same argument as *size*.
+            Padding between the axes.  float or str arguments are interpreted
+            as ``axes_size.from_any(size, AxesY(self))``.  Defaults to
+            :rc:`figure.subplot.hspace` times the current axes height.
         pack_start : bool
             If False, the new axes is appended at the end
             of the list, i.e., it became the right-most axes. If True, it is
@@ -499,10 +499,7 @@ def new_vertical(self, size, pad=None, pack_start=False, **kwargs):
             main axes will be used.
         """
         if pad is None:
-            _api.warn_deprecated(
-                "3.2", message="In a future version, 'pad' will default to "
-                "rcParams['figure.subplot.hspace'].  Set pad=0 to keep the "
-                "old behavior.")
+            pad = mpl.rcParams["figure.subplot.hspace"] * self._yref
         if pad:
             if not isinstance(pad, Size._Base):
                 pad = Size.from_any(pad, fraction_ref=self._yref)
diff --git a/lib/mpl_toolkits/tests/test_axes_grid1.py b/lib/mpl_toolkits/tests/test_axes_grid1.py
@@ -1,7 +1,7 @@
 from itertools import product
 import platform
 
-import matplotlib
+import matplotlib as mpl
 import matplotlib.pyplot as plt
 from matplotlib import cbook
 from matplotlib.backend_bases import MouseEvent
@@ -56,9 +56,8 @@ def test_divider_append_axes():
 @image_comparison(['twin_axes_empty_and_removed'], extensions=["png"], tol=1)
 def test_twin_axes_empty_and_removed():
     # Purely cosmetic font changes (avoid overlap)
-    matplotlib.rcParams.update({"font.size": 8})
-    matplotlib.rcParams.update({"xtick.labelsize": 8})
-    matplotlib.rcParams.update({"ytick.labelsize": 8})
+    mpl.rcParams.update(
+        {"font.size": 8, "xtick.labelsize": 8, "ytick.labelsize": 8})
     generators = ["twinx", "twiny", "twin"]
     modifiers = ["", "host invisible", "twin removed", "twin invisible",
                  "twin removed\nhost invisible"]
@@ -348,7 +347,8 @@ def test_anchored_direction_arrows_many_args():
 def test_axes_locatable_position():
     fig, ax = plt.subplots()
     divider = make_axes_locatable(ax)
-    cax = divider.append_axes('right', size='5%', pad='2%')
+    with mpl.rc_context({"figure.subplot.wspace": 0.02}):
+        cax = divider.append_axes('right', size='5%')
     fig.canvas.draw()
     assert np.isclose(cax.get_position(original=False).width,
                       0.03621495327102808)
