Also templatize x/y/zaxis_date.

anntzer · anntzer · commit 73e44cc0b476 · 2020-04-04T12:34:02.000+02:00
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1,6 +1,7 @@
 from collections import OrderedDict
 from contextlib import ExitStack
 import functools
+import inspect
 import itertools
 import logging
 import math
@@ -44,7 +45,8 @@ def _axis_method_wrapper(attr_name, method_name, *, doc_sub=None):
 
     The docstring of ``get_foo`` is built by replacing "this Axis" by "the
     {attr_name}" ("the xaxis", "the yaxis") in the wrapped method's docstring;
-    additional replacements can by given in *doc_sub*.
+    additional replacements can by given in *doc_sub*.  The docstring is also
+    dedented to simplify further manipulations.
     """
 
     method = getattr(maxis.Axis, method_name)
@@ -62,7 +64,7 @@ def wrapper(self, *args, **kwargs):
                 (f"The docstring of wrapped Axis method {method_name!r} must "
                  f"contain {k!r} as a substring.")
             doc = doc.replace(k, v)
-        wrapper.__doc__ = doc
+        wrapper.__doc__ = inspect.cleandoc(doc)
 
     return wrapper
 
@@ -3635,29 +3637,8 @@ def set_yscale(self, value, **kwargs):
         "yaxis", "_set_ticklabels",
         doc_sub={"Axis.set_ticks": "Axes.set_yticks"})
 
-    def xaxis_date(self, tz=None):
-        """
-        Sets up x-axis ticks and labels that treat the x data as dates.
-
-        Parameters
-        ----------
-        tz : str or `datetime.tzinfo`, default: :rc:`timezone`
-            Timezone.
-        """
-        # should be enough to inform the unit conversion interface
-        # dates are coming in
-        self.xaxis.axis_date(tz)
-
-    def yaxis_date(self, tz=None):
-        """
-        Sets up y-axis ticks and labels that treat the y data as dates.
-
-        Parameters
-        ----------
-        tz : str or `datetime.tzinfo`, default: :rc:`timezone`
-            Timezone.
-        """
-        self.yaxis.axis_date(tz)
+    xaxis_date = _axis_method_wrapper("xaxis", "axis_date")
+    yaxis_date = _axis_method_wrapper("yaxis", "axis_date")
 
     def format_xdata(self, x):
         """
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -1752,11 +1752,11 @@ def zoom(self, direction):
 
     def axis_date(self, tz=None):
         """
-        Sets up axis ticks and labels treating data along this axis as dates.
+        Sets up axis ticks and labels to treat data along this Axis as dates.
 
         Parameters
         ----------
-        tz : tzinfo or str or None
+        tz : str or `datetime.tzinfo`, default: :rc:`timezone`
             The timezone used to create date labels.
         """
         # By providing a sample datetime instance with the desired timezone,
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -13,6 +13,7 @@
 from collections import defaultdict
 from functools import reduce
 import math
+import textwrap
 
 import numpy as np
 
@@ -830,23 +831,15 @@ def set_zscale(self, value, **kwargs):
         "zaxis", "_set_ticklabels",
         doc_sub={"Axis.set_ticks": "Axes.set_zticks"})
 
-    def zaxis_date(self, tz=None):
-        """
-        Sets up z-axis ticks and labels that treat the z data as dates.
-
-        .. note::
-            This function is merely provided for completeness.
-            Axes3D objects do not officially support dates for ticks,
-            and so this may or may not work as expected.
-
-        .. versionadded:: 1.1.0
-            This function was added, but not tested. Please report any bugs.
+    zaxis_date = _axis_method_wrapper("zaxis", "axis_date")
+    if zaxis_date.__doc__:
+        zaxis_date.__doc__ += textwrap.dedent("""
 
-        Parameters
-        ----------
-        tz : `datetime.tzinfo`, default: :rc:`timezone`
-        """
-        self.zaxis.axis_date(tz)
+        Notes
+        -----
+        This function is merely provided for completeness, but 3d axes do not
+        support dates for ticks, and so this may not work as expected.
+        """)
 
     def clabel(self, *args, **kwargs):
         """
