DOC: Added API entry, fixed Legend.get_tightbbox string

jklymak · jklymak · commit 485dd685521a · 2018-03-24T14:07:29.000-07:00
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -262,14 +262,14 @@ def get_tightbbox(self, renderer):
 
         Parameters
         ----------
-        renderer : RendererBase instance
+        renderer : `.RendererBase` instance
             renderer that will be used to draw the figures (i.e.
             ``fig.canvas.get_renderer()``)
 
         Returns
         -------
-        `BboxBase` : containing the bounding box (in figure-relative
-            co-ordinates).
+        bbox : `.BboxBase`
+            containing the bounding box (in figure pixel co-ordinates).
         """
 
         bbox = self.get_window_extent(renderer)
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -4101,11 +4101,11 @@ def get_tightbbox(self, renderer, call_axes_locator=True,
 
         Parameters
         ----------
-        renderer : RendererBase instance
+        renderer : `.RendererBase` instance
             renderer that will be used to draw the figures (i.e.
             ``fig.canvas.get_renderer()``)
 
-        bbox_extra_artists : list of `Artist` or ``None``
+        bbox_extra_artists : list of `.Artist` or ``None``
             List of artists to include in the tight bounding box.  If
             ``None`` (default), then all artist children of the axes are
             included in the tight bounding box.
@@ -4119,7 +4119,8 @@ def get_tightbbox(self, renderer, call_axes_locator=True,
 
         Returns
         -------
-        `BboxBase` : containing the bounding box (in relative co-ordinates).
+        bbox : `.BboxBase`
+            containing the bounding box (in figure pixel co-ordinates).
         """
 
         bb = []
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2038,18 +2038,19 @@ def get_tightbbox(self, renderer, bbox_extra_artists=None):
 
         Parameters
         ----------
-        renderer : RendererBase instance
+        renderer : `.RendererBase` instance
             renderer that will be used to draw the figures (i.e.
             ``fig.canvas.get_renderer()``)
 
-        bbox_extra_artists : list of `Artist` or ``None``
+        bbox_extra_artists : list of `.Artist` or ``None``
             List of artists to include in the tight bounding box.  If
             ``None`` (default), then all artist children of each axes are
             included in the tight bounding box.
 
         Returns
         -------
-        `BboxBase` : containing the bounding box (in figure co-ordinates).
+        bbox : `.BboxBase`
+            containing the bounding box (in figure inches).
         """
 
         bb = []
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -955,7 +955,20 @@ def get_window_extent(self, *args, **kwargs):
         return self.legendPatch.get_window_extent(*args, **kwargs)
 
     def get_tightbbox(self, renderer):
-        'Return extent of the legend.'
+        """
+        Like `.Legend.get_window_extent`, but uses the box for the legend.
+
+        Parameters
+        ----------
+        renderer : `.RendererBase` instance
+            renderer that will be used to draw the figures (i.e.
+            ``fig.canvas.get_renderer()``)
+
+        Returns
+        -------
+        `.BboxBase` : containing the bounding box (in figure-relative
+            co-ordinates).
+        """
         return self._legend_box.get_window_extent(renderer)
 
     def get_frame_on(self):
