Merge pull request #18353 from l-johnston/issue_18345

jklymak · web-flow · commit e26d4974d040 · 2020-09-08T09:11:22.000-07:00
DOCS: describe shared axes behavior with units
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -286,6 +286,10 @@ def subplots(self, *, sharex=False, sharey=False, squeeze=True,
             first column subplot are created. To later turn other subplots'
             ticklabels on, use `~matplotlib.axes.Axes.tick_params`.
 
+            When subplots have a shared axis that has units, calling
+            `~matplotlib.axis.Axis.set_units` will update each axis with the
+            new units.
+
         squeeze : bool, optional, default: True
             - If True, extra dimensions are squeezed out from the returned
               array of Axes:
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1258,6 +1258,10 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
         column subplot are created. To later turn other subplots' ticklabels
         on, use `~matplotlib.axes.Axes.tick_params`.
 
+        When subplots have a shared axis that has units, calling
+        `~matplotlib.axis.Axis.set_units` will update each axis with the
+        new units.
+
     squeeze : bool, default: True
         - If True, extra dimensions are squeezed out from the returned
           array of `~matplotlib.axes.Axes`:
