DOC: improve docs a bit

jklymak · jklymak · commit c118f847d1d3 · 2021-06-23T18:45:26.000-07:00
diff --git a/doc/api/next_api_changes/behavior/20054-JMK.rst b/doc/api/next_api_changes/behavior/20054-JMK.rst
@@ -1,15 +1,3 @@
-Axes used to make colorbar now wrapped
-======================================
-
-The axes used to place a colorbar is now wrapped by a new parent class
-(``ColorbarAxes``) when the colorbar is created::
-
-    cb = fig.colorbar(im, cax=cax)
-
-This means that ``cb.ax`` is no longer the same object as ``cax``. However, 
-we map all the methods from ``cb.ax`` onto ``cax`` so ``cax`` should remain 
-functionally the same as ``cb.ax``.  
-
 Colorbar lines no longer clipped
 ================================
 
diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py
@@ -228,7 +228,11 @@ def draw(self, renderer):
         return ret
 
 
-class _ColorbarLocator:
+class _ColorbarAxesLocator:
+    """
+    Wrap any locator on the axes, or its position, to shrink the 
+    inner axes if there are extend triangles at either min or max.  
+    """
     def __init__(self, cbar):
         """
         *bounds* (a ``[l, b, w, h]`` rectangle) and *transform* together
@@ -248,36 +252,39 @@ def __call__(self, ax, renderer):
         lim = self._cbar._long_axis().get_view_interval()
         self._cbar._short_axis().set_view_interval(*lim)
 
-        pos = ax.get_position(original=True)
         if self._orig_locator is not None:
             pos = self._orig_locator(ax, renderer)
+        else:
+            pos = ax.get_position(original=True)
         if self._cbar.extend == 'neither':
             return pos
+        
+        y, extendlen = self._cbar._proportional_y()
+        if not self._cbar._extend_lower():
+            extendlen[0] = 0
+        if not self._cbar._extend_upper():
+            extendlen[1] = 0
+        len = sum(extendlen) + 1
+        shrink = 1 / len
+        offset = extendlen[0] / len
+        # we need to reset the aspect ratio of the axes to account
+        # of the extends...
+        if not self._cbar._userax:
+            aspect = ax._colorbar_info['aspect']
         else:
-            y, extendlen = self._cbar._proportional_y()
-            if not self._cbar._extend_lower():
-                extendlen[0] = 0
-            if not self._cbar._extend_upper():
-                extendlen[1] = 0
-            len = sum(extendlen) + 1
-            shrink = 1 / len
-            offset = extendlen[0] / len
-            # we need to reset the aspect ratio of the axes to account
-            # of the extends...
-            if not self._cbar._userax:
-                aspect = ax._colorbar_info['aspect']
-            else:
-                aspect = False
-            if self._cbar.orientation == 'vertical':
-                if aspect:
-                    ax.set_aspect(aspect*shrink)
-                offset = offset * pos.height
-                pos = pos.shrunk(1, shrink).translated(0, offset)
-            else:
-                if aspect:
-                    ax.set_aspect(aspect/shrink)
-                offset = offset * pos.width
-                pos = pos.shrunk(shrink, 1).translated(offset, 0)
+            aspect = False
+        # now shrink and/or offset to take into account the 
+        # extend tri/rectangles.  
+        if self._cbar.orientation == 'vertical':
+            if aspect:
+                ax.set_aspect(aspect*shrink)
+            offset = offset * pos.height
+            pos = pos.shrunk(1, shrink).translated(0, offset)
+        else:
+            if aspect:
+                ax.set_aspect(aspect/shrink)
+            offset = offset * pos.width
+            pos = pos.shrunk(shrink, 1).translated(offset, 0)
         return pos
 
 
@@ -421,7 +428,7 @@ def __init__(self, ax, mappable=None, *, cmap=None,
 
         self.ax = ax
         self._userax = userax
-        self.ax._axes_locator = _ColorbarLocator(self)
+        self.ax._axes_locator = _ColorbarAxesLocator(self)
         ax.set(navigate=False)
 
         if extend is None:
@@ -606,8 +613,7 @@ def _add_solids_patches(self, X, Y, C, mappable):
 
     def _do_extends(self, extendlen):
         """
-        Make adjustments of the inner axes for the extend triangles (or
-        rectanges) and add them as patches.
+        Add the extend tri/rectangles on the outside of the axes.
         """
         # extend lengths are fraction of the *inner* part of colorbar,
         # not the total colorbar:
@@ -767,10 +773,6 @@ def add_lines(self, *args, **kwargs):
         self.ax.add_collection(col)
         self.stale = True
 
-    def set_scale(self, scale):
-        self.ax.set_xscale(scale)
-        self.ax.set_yscale(scale)
-
     def update_ticks(self):
         """
         Setup the ticks and ticklabels. This should not be needed by users.
