Merge pull request #21286 from anntzer/fgtb

tacaswell · web-flow · commit 905f10372859 · 2021-10-06T22:54:15.000-04:00
DOC: Clarify FigureBase.tight_bbox as different from all other artists.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1596,7 +1596,10 @@ def get_default_bbox_extra_artists(self):
 
     def get_tightbbox(self, renderer, bbox_extra_artists=None):
         """
-        Return a (tight) bounding box of the figure in inches.
+        Return a (tight) bounding box of the figure *in inches*.
+
+        Note that `.FigureBase` differs from all other artists, which return
+        their `.Bbox` in pixels.
 
         Artists that have ``artist.set_in_layout(False)`` are not included
         in the bbox.
