DOC: Axes.indicate_inset* methods

clbarnes · clbarnes · commit 767715f0b2eb · 2019-05-20T13:56:31.000-04:00
1. Method docstring stated that they output a tuple when it was a list; now fixed 2. Docstring for indicate_inset_zoom referred to nonexistent method Axes.inset_rectangle; now correctly refers to Axes.indicate_inset. See issue #14275
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -530,9 +530,10 @@ def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
         rectangle_patch : `.Patches.Rectangle`
              Rectangle artist.
 
-        connector_lines : 4-tuple of `.Patches.ConnectionPatch`
-            One for each of four connector lines.  Two are set with visibility
-            to *False*,  but the user can set the visibility to True if the
+        connector_lines : list of `.Patches.ConnectionPatch`
+            One for each of four connector lines.
+            Two are set with visibility to *False*,
+            but the user can set the visibility to *True* if the
             automatic choice is not deemed correct.
 
         """
@@ -601,17 +602,17 @@ def indicate_inset_zoom(self, inset_ax, **kwargs):
             chosen so as to not overlap with the indicator box.
 
         **kwargs
-            Other *kwargs* are passed on to `.Axes.inset_rectangle`
+            Other *kwargs* are passed on to `.Axes.indicate_inset`
 
         Returns
         -------
 
         rectangle_patch : `.Patches.Rectangle`
              Rectangle artist.
 
-        connector_lines : 4-tuple of `.Patches.ConnectionPatch`
+        connector_lines : list of `.Patches.ConnectionPatch`
             One for each of four connector lines.  Two are set with visibility
-            to *False*,  but the user can set the visibility to True if the
+            to *False*,  but the user can set the visibility to *True* if the
             automatic choice is not deemed correct.
 
         """
