Merge pull request #27446 from meeseeksmachine/auto-backport-of-pr-27397-on-v3.8.x

story645 · web-flow · commit 229a49a13546 · 2023-12-05T18:39:14.000-05:00
Backport PR #27397 on branch v3.8.x (SpanSelector widget: Improve doc for `extents`)
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -2915,7 +2915,12 @@ def _snap(values, snap_values):
 
     @property
     def extents(self):
-        """Return extents of the span selector."""
+        """
+        (float, float)
+            The values, in data coordinates, for the start and end points of the current
+            selection. If there is no selection then the start and end values will be
+            the same.
+        """
         if self.direction == 'horizontal':
             vmin = self._selection_artist.get_x()
             vmax = vmin + self._selection_artist.get_width()
