ENH: add colorbar method to axes

jklymak · jklymak · commit e7cb45eaeeca · 2018-09-28T16:31:01.000-07:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -418,6 +418,21 @@ def legend(self, *args, **kwargs):
     def _remove_legend(self, legend):
         self.legend_ = None
 
+    @docstring.dedent_interpd
+    def colorbar(self, mappable, cax=None, use_gridspec=True, **kw):
+        """
+        Create a colorbar for a ScalarMappable instance, *mappable*, with the
+        axes as the parent.
+
+        Documentation for the pyplot thin wrapper:
+        %(colorbar_doc)s
+        """
+        ax = kw.pop(ax)
+        if ax is not None:
+            warnings.warn('Supplied ax argument ignored')
+        self.figure.colorbar(self, mappable, cax=cax, ax=self,
+                             use_gridspec=use_gridspec, **kw)
+
     def inset_axes(self, bounds, *, transform=None, zorder=5,
             **kwargs):
         """
diff --git a/lib/mpl_toolkits/axes_grid1/colorbar.py b/lib/mpl_toolkits/axes_grid1/colorbar.py
@@ -109,7 +109,8 @@
     the :class:`~matplotlib.image.Image`,
     :class:`~matplotlib.contour.ContourSet`, etc. to
     which the colorbar applies; this argument is mandatory for the
-    :meth:`~matplotlib.figure.Figure.colorbar` method but optional for the
+    :meth:`~matplotlib.figure.Figure.colorbar`
+    and :meth:`~matplotlib.axes.Axes.colorbar` methods but optional for the
     :func:`~matplotlib.pyplot.colorbar` function, which sets the
     default to the current image.
 
@@ -119,7 +120,7 @@
     None | axes object into which the colorbar will be drawn
   *ax*
     None | parent axes object from which space for a new
-    colorbar axes will be stolen
+    colorbar axes will be stolen (ignored for `.axes.Axes.colorbar`)
 
 
 Additional keyword arguments are of two kinds:
