Merge pull request #16054 from meeseeksmachine/auto-backport-of-pr-16048-on-v3.2.x

timhoffm · web-flow · commit c8313016aa38 · 2019-12-31T13:34:58.000+01:00
Backport PR #16048 on branch v3.2.x (Document that colorbar() takes a label kwarg.)
diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py
@@ -106,6 +106,8 @@
                   given instead.
     *drawedges*   bool
                   Whether to draw lines at color boundaries.
+    *label*       str
+                  The label on the colorbar's long axis.
     ============  ====================================================
 
     The following will probably be useful only in the context of
@@ -168,8 +170,7 @@
 Returns
 -------
 colorbar : `~matplotlib.colorbar.Colorbar`
-    See also its base class, `~matplotlib.colorbar.ColorbarBase`.  Use
-    `~.ColorbarBase.set_label` to label the colorbar.
+    See also its base class, `~matplotlib.colorbar.ColorbarBase`.
 
 Notes
 -----
