Fix indentation docstring, update API changes and update SpanSelector example

ericpre · ericpre · commit 00444e4ff371 · 2021-07-19T09:39:20.000+01:00
diff --git a/doc/api/next_api_changes/deprecations/20585-EP.rst b/doc/api/next_api_changes/deprecations/20585-EP.rst
@@ -1,9 +1,32 @@
+Unification of Selector API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The API for Selector widgets has been unified to use
+
+- *props* for the properties of the Artist representing the selection.
+- *handle_props* for the Artists representing handles for modifying the selection.
+- *grab_range* for the maximal tolerance to grab a handle with the mouse.
+
+This affects the following parameters and attributes:
+
+
 RectangleSelector and EllipseSelector
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 The *maxdist* argument is deprecated, use *grab_range* instead.
+The *rectprops* argument is deprecated, use *props* instead.
 The *marker_props* argument is deprecated, use *handle_props* instead.
 
 PolygonSelector
-~~~~~~~~~~~~~~~
-The *vertex_select_radius* argument is deprecated, use *grab_range* instead.
+^^^^^^^^^^^^^^^
+The *vertex_select_radius* argument and attribute is deprecated, use *grab_range* instead.
+The *lineprops* argument is deprecated, use *props* instead.
 The *markerprops* argument is deprecated, use *handle_props* instead.
+The *maxdist* argument and attribute is deprecated, use *grab_range* instead.
+
+SpanSelector
+^^^^^^^^^^^^
+The *rectprops* argument is deprecated, use *props* instead.
+The *maxdist* argument and attribute is deprecated, use *grab_range* instead.
+
+LassoSelector
+^^^^^^^^^^^^^
+The *lineprops* argument is deprecated, use *props* instead.
diff --git a/examples/widgets/span_selector.py b/examples/widgets/span_selector.py
@@ -53,7 +53,7 @@ def onselect(xmin, xmax):
     onselect,
     "horizontal",
     useblit=True,
-    rectprops=dict(alpha=0.5, facecolor="tab:blue"),
+    props=dict(alpha=0.5, facecolor="tab:blue"),
     interactive=True,
     drag_from_anywhere=True
 )
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -2542,7 +2542,7 @@ def onselect(eclick: MouseEvent, erelease: MouseEvent)
         `matplotlib.patches.Patch` for valid properties.
         Default:
 
-            ``dict(facecolor='red', edgecolor='black', alpha=0.2, fill=True)``
+        ``dict(facecolor='red', edgecolor='black', alpha=0.2, fill=True)``
 
     spancoords : {"data", "pixels"}, default: "data"
         Whether to interpret *minspanx* and *minspany* in data or in pixel

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ def onselect(xmin, xmax):`
`53`	`53`	`onselect,`
`54`	`54`	`"horizontal",`
`55`	`55`	`useblit=True,`
`56`		`- rectprops=dict(alpha=0.5, facecolor="tab:blue"),`
	`56`	`+ props=dict(alpha=0.5, facecolor="tab:blue"),`
`57`	`57`	`interactive=True,`
`58`	`58`	`drag_from_anywhere=True`
`59`	`59`	`)`