[Doc] consolidate rect documentation (#22820)

Sync271 · jklymak · web-flow · commit 297feee5d8de · 2022-07-01T09:29:53.000+02:00
* consolidate rect documentation

* restore explanation

* fix rect definition formatting

Co-Authored-By: Jody Klymak &lt;jklymak@gmail.com&gt;

* fix trailing white space and rect definition for `add_axes()`

Co-Authored-By: Jody Klymak &lt;jklymak@gmail.com&gt;

Co-authored-by: Jody Klymak &lt;jklymak@gmail.com&gt;
diff --git a/lib/matplotlib/_tight_layout.py b/lib/matplotlib/_tight_layout.py
@@ -41,8 +41,8 @@ def _auto_adjust_subplotpars(
     h_pad, w_pad : float
         Padding (height/width) between edges of adjacent subplots, as a
         fraction of the font size.  Defaults to *pad*.
-    rect : tuple[float, float, float, float]
-        [left, bottom, right, top] in normalized (0, 1) figure coordinates.
+    rect : tuple
+        (left, bottom, right, top), default: None.
     """
     rows, cols = shape
 
@@ -183,8 +183,8 @@ def auto_adjust_subplotpars(
     h_pad, w_pad : float
         Padding (height/width) between edges of adjacent subplots, as a
         fraction of the font size.  Defaults to *pad*.
-    rect : tuple[float, float, float, float]
-        [left, bottom, right, top] in normalized (0, 1) figure coordinates.
+    rect : tuple
+        (left, bottom, right, top), default: None.
     """
     nrows, ncols = nrows_ncols
     span_pairs = []
@@ -250,8 +250,8 @@ def get_tight_layout_figure(fig, axes_list, subplotspec_list, renderer,
     h_pad, w_pad : float
         Padding (height/width) between edges of adjacent subplots.  Defaults to
         *pad*.
-    rect : tuple[float, float, float, float], optional
-        (left, bottom, right, top) rectangle in normalized figure coordinates
+    rect : tuple (left, bottom, right, top), default: None.
+        rectangle in normalized figure coordinates
         that the whole subplots area (including labels) will fit into.
         Defaults to using the entire figure.
 
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -589,7 +589,7 @@ def __init__(self, fig, rect,
         fig : `~matplotlib.figure.Figure`
             The Axes is built in the `.Figure` *fig*.
 
-        rect : [left, bottom, width, height]
+        rect : tuple (left, bottom, width, height).
             The Axes is built in the rectangle *rect*. *rect* is in
             `.Figure` coordinates.
 
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -519,8 +519,8 @@ def add_axes(self, *args, **kwargs):
 
         Parameters
         ----------
-        rect : sequence of float
-            The dimensions [left, bottom, width, height] of the new Axes. All
+        rect : tuple (left, bottom, width, height)
+            The dimensions (left, bottom, width, height) of the new Axes. All
             quantities are in fractions of figure width and height.
 
         projection : {None, 'aitoff', 'hammer', 'lambert', 'mollweide', \
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -460,10 +460,10 @@ def tight_layout(self, figure, renderer=None,
         h_pad, w_pad : float, optional
             Padding (height/width) between edges of adjacent subplots.
             Defaults to *pad*.
-        rect : tuple of 4 floats, default: (0, 0, 1, 1), i.e. the whole figure
+        rect : tuple (left, bottom, right, top), default: None
             (left, bottom, right, top) rectangle in normalized figure
             coordinates that the whole subplots area (including labels) will
-            fit into.
+            fit into. Default (None) is the whole figure.
         """
 
         subplotspec_list = _tight_layout.get_subplotspec_list(
diff --git a/lib/matplotlib/layout_engine.py b/lib/matplotlib/layout_engine.py
@@ -121,10 +121,9 @@ def __init__(self, *, pad=1.08, h_pad=None, w_pad=None,
         h_pad, w_pad : float
             Padding (height/width) between edges of adjacent subplots.
             Defaults to *pad*.
-        rect : tuple of 4 floats, optional
-            (left, bottom, right, top) rectangle in normalized figure
-            coordinates that the subplots (including labels)
-            will fit into. Defaults to using the entire figure.
+        rect : tuple (left, bottom, right, top), default: (0, 0, 1, 1).
+            rectangle in normalized figure coordinates that the subplots
+            (including labels) will fit into.
         """
         super().__init__(**kwargs)
         for td in ['pad', 'h_pad', 'w_pad', 'rect']:
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -63,7 +63,7 @@ def __init__(
         ----------
         fig : Figure
             The parent figure.
-        rect : (float, float, float, float)
+        rect : tuple (left, bottom, width, height), default: None.
             The ``(left, bottom, width, height)`` axes position.
         elev : float, default: 30
             The elevation angle in degrees rotates the camera above and below
