Harmonize descriptions of the 'anchor' parameter.

anntzer · anntzer · commit 14745cd87d91 · 2021-04-26T10:27:36.000+02:00
... across the library.  I left the table for Axes.set_anchor (likely
the most common entry-point), but it doesn't seem worth copying it at
the other use sites.

Divider.set_anchor also supports pairs of floats (it just forwards to
Bbox.anchored anyways).
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1780,28 +1780,21 @@ def set_anchor(self, anchor, share=False):
 
         Parameters
         ----------
-        anchor : 2-tuple of floats or {'C', 'SW', 'S', 'SE', ...}
-            The anchor position may be either:
-
-            - a sequence (*cx*, *cy*). *cx* and *cy* may range from 0
-              to 1, where 0 is left or bottom and 1 is right or top.
-
-            - a string using cardinal directions as abbreviation:
-
-              - 'C' for centered
-              - 'S' (south) for bottom-center
-              - 'SW' (south west) for bottom-left
-              - etc.
-
-              Here is an overview of the possible positions:
-
-              +------+------+------+
-              | 'NW' | 'N'  | 'NE' |
-              +------+------+------+
-              | 'W'  | 'C'  | 'E'  |
-              +------+------+------+
-              | 'SW' | 'S'  | 'SE' |
-              +------+------+------+
+        anchor : (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
+            Either an (*x*, *y*) pair of relative coordinates (0 is left or
+            bottom, 1 is right or top), 'C' (center), or a cardinal direction
+            ('SW', southwest, is bottom left, etc.).  str inputs are shorthands
+            for (*x*, *y*) coordinates, as shown in the following table::
+
+            .. code-block:: none
+
+               +-----------------+-----------------+-----------------+
+               | 'NW' (0.0, 1.0) | 'N' (0.5, 1.0)  | 'NE' (1.0, 1.0) |
+               +-----------------+-----------------+-----------------+
+               | 'W'  (0.0, 0.5) | 'C' (0.5, 0.5)  | 'E'  (1.0, 0.5) |
+               +-----------------+-----------------+-----------------+
+               | 'SW' (0.0, 0.0) | 'S' (0.5, 0.0)  | 'SE' (1.0, 0.0) |
+               +-----------------+-----------------+-----------------+
 
         share : bool, default: False
             If ``True``, apply the settings to all shared Axes.
diff --git a/lib/matplotlib/transforms.py b/lib/matplotlib/transforms.py
@@ -513,26 +513,21 @@ def inverse_transformed(self, transform):
 
     def anchored(self, c, container=None):
         """
-        Return a copy of the `Bbox` shifted to position *c* within *container*.
+        Return a copy of the `Bbox` anchored to *c* within *container*.
 
         Parameters
         ----------
-        c : (float, float) or str
-            May be either:
-
-            * A sequence (*cx*, *cy*) where *cx* and *cy* range from 0
-              to 1, where 0 is left or bottom and 1 is right or top
-
-            * a string:
-              - 'C' for centered
-              - 'S' for bottom-center
-              - 'SE' for bottom-left
-              - 'E' for left
-              - etc.
-
+        c : (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
+            Either an (*x*, *y*) pair of relative coordinates (0 is left or
+            bottom, 1 is right or top), 'C' (center), or a cardinal direction
+            ('SW', southwest, is bottom left, etc.).
         container : `Bbox`, optional
             The box within which the `Bbox` is positioned; it defaults
             to the initial `Bbox`.
+
+        See Also
+        --------
+        .Axes.set_anchor
         """
         if container is None:
             container = self
diff --git a/lib/mpl_toolkits/axes_grid1/axes_divider.py b/lib/mpl_toolkits/axes_grid1/axes_divider.py
@@ -104,23 +104,14 @@ def set_anchor(self, anchor):
         """
         Parameters
         ----------
-        anchor : {'C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W'}
-            anchor position
-
-          =====  ============
-          value  description
-          =====  ============
-          'C'    Center
-          'SW'   bottom left
-          'S'    bottom
-          'SE'   bottom right
-          'E'    right
-          'NE'   top right
-          'N'    top
-          'NW'   top left
-          'W'    left
-          =====  ============
-
+        anchor : (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
+            Either an (*x*, *y*) pair of relative coordinates (0 is left or
+            bottom, 1 is right or top), 'C' (center), or a cardinal direction
+            ('SW', southwest, is bottom left, etc.).
+
+        See Also
+        --------
+        .Axes.set_anchor
         """
         if len(anchor) != 2:
             _api.check_in_list(mtransforms.Bbox.coefs, anchor=anchor)
