Merge pull request matplotlib#21287 from anntzer/id

timhoffm · web-flow · commit 9e2f309e3d96 · 2021-10-15T02:51:50.000+02:00
Inherit more docstrings.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -302,7 +302,7 @@ def stale(self, val):
 
     def get_window_extent(self, renderer):
         """
-        Get the axes bounding box in display space.
+        Get the artist's bounding box in display space.
 
         The bounding box' width and height are nonnegative.
 
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -317,9 +317,7 @@ def contains(self, mouseevent):
         return inside, {}
 
     def get_window_extent(self, *args, **kwargs):
-        """
-        Return the figure bounding box in display space. Arguments are ignored.
-        """
+        # docstring inherited
         return self.bbox
 
     def _suplabels(self, t, info, **kwargs):
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -900,20 +900,7 @@ def get_window_extent(self, renderer=None):
         return self._legend_box.get_window_extent(renderer=renderer)
 
     def get_tightbbox(self, renderer):
-        """
-        Like `.Legend.get_window_extent`, but uses the box for the legend.
-
-        Parameters
-        ----------
-        renderer : `.RendererBase` subclass
-            renderer that will be used to draw the figures (i.e.
-            ``fig.canvas.get_renderer()``)
-
-        Returns
-        -------
-        `.BboxBase`
-            The bounding box in figure pixel coordinates.
-        """
+        # docstring inherited
         return self._legend_box.get_window_extent(renderer)
 
     def get_frame_on(self):
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -346,7 +346,7 @@ def get_extent(self, renderer):
         return w, h, xd, yd
 
     def get_window_extent(self, renderer):
-        """Return the bounding box (`.Bbox`) in display space."""
+        # docstring inherited
         w, h, xd, yd, offsets = self.get_extent_offsets(renderer)
         px, py = self.get_offset(w, h, xd, yd, renderer)
         return mtransforms.Bbox.from_bounds(px - xd, py - yd, w, h)
@@ -640,7 +640,7 @@ def get_offset(self):
         return self._offset
 
     def get_window_extent(self, renderer):
-        """Return the bounding box in display space."""
+        # docstring inherited
         w, h, xd, yd = self.get_extent(renderer)
         ox, oy = self.get_offset()  # w, h, xd, yd)
 
@@ -800,7 +800,7 @@ def get_offset(self):
         return self._offset
 
     def get_window_extent(self, renderer):
-        """Return the bounding box in display space."""
+        # docstring inherited
         w, h, xd, yd = self.get_extent(renderer)
         ox, oy = self.get_offset()
         return mtransforms.Bbox.from_bounds(ox - xd, oy - yd, w, h)
@@ -901,7 +901,7 @@ def get_offset(self):
         return self._offset
 
     def get_window_extent(self, renderer):
-        """Return the bounding box in display space."""
+        # docstring inherited
         w, h, xd, yd = self.get_extent(renderer)
         ox, oy = self.get_offset()  # w, h, xd, yd)
         return mtransforms.Bbox.from_bounds(ox - xd, oy - yd, w, h)
@@ -1085,7 +1085,7 @@ def set_bbox_to_anchor(self, bbox, transform=None):
         self.stale = True
 
     def get_window_extent(self, renderer):
-        """Return the bounding box in display space."""
+        # docstring inherited
         self._update_offset_func(renderer)
         w, h, xd, yd = self.get_extent(renderer)
         ox, oy = self.get_offset(w, h, xd, yd, renderer)
@@ -1249,7 +1249,7 @@ def get_children(self):
         return [self.image]
 
     def get_window_extent(self, renderer):
-        """Return the bounding box in display space."""
+        # docstring inherited
         w, h, xd, yd = self.get_extent(renderer)
         ox, oy = self.get_offset()
         return mtransforms.Bbox.from_bounds(ox - xd, oy - yd, w, h)
@@ -1440,18 +1440,14 @@ def get_fontsize(self):
         return self.prop.get_size_in_points()
 
     def get_window_extent(self, renderer):
-        """
-        get the bounding box in display space.
-        """
+        # docstring inherited
         bboxes = [child.get_window_extent(renderer)
                   for child in self.get_children()]
 
         return Bbox.union(bboxes)
 
     def get_tightbbox(self, renderer):
-        """
-        get tight bounding box in display space.
-        """
+        # docstring inherited
         bboxes = [child.get_tightbbox(renderer)
                   for child in self.get_children()]
 
diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py
@@ -447,7 +447,7 @@ def get_children(self):
         return list(self._cells.values())
 
     def get_window_extent(self, renderer):
-        """Return the bounding box of the table in window coords."""
+        # docstring inherited
         self._update_positions(renderer)
         boxes = [cell.get_window_extent(renderer)
                  for cell in self._cells.values()]
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -1987,18 +1987,7 @@ def draw(self, renderer):
         Text.draw(self, renderer)
 
     def get_window_extent(self, renderer=None):
-        """
-        Return the `.Bbox` bounding the text and arrow, in display units.
-
-        Parameters
-        ----------
-        renderer : Renderer, optional
-            A renderer is needed to compute the bounding box.  If the artist
-            has already been drawn, the renderer is cached; thus, it is only
-            necessary to pass this argument when calling `get_window_extent`
-            before the first `draw`.  In practice, it is usually easier to
-            trigger a draw first (e.g. by saving the figure).
-        """
+        # docstring inherited
         # This block is the same as in Text.get_window_extent, but we need to
         # set the renderer before calling update_positions().
         if not self.get_visible() or not self._check_xy(renderer):
diff --git a/lib/mpl_toolkits/mplot3d/axis3d.py b/lib/mpl_toolkits/mplot3d/axis3d.py
@@ -451,7 +451,7 @@ def draw(self, renderer):
     # TODO: Get this to work (more) properly when mplot3d supports the
     #       transforms framework.
     def get_tightbbox(self, renderer, *, for_layout_only=False):
-        # inherited docstring
+        # docstring inherited
         if not self.get_visible():
             return
         # We have to directly access the internal data structures
