Move RectangleSelector from __init__ to class docstring.

Author: ericpre

lib/matplotlib/widgets.py

@@ -2499,103 +2499,102 @@ def closest(self, x, y):
 
 
 class RectangleSelector(_SelectorWidget):
-    """
+    r"""
     Select a rectangular region of an axes.
 
     For the cursor to remain responsive you must keep a reference to it.
 
-    Examples
-    --------
-    :doc:`/gallery/widgets/rectangle_selector`
-    """
+    Parameters
+    ----------
+    ax : `~matplotlib.axes.Axes`
+        The parent axes for the widget.
 
-    _shape_klass = Rectangle
+    onselect : function
+        A callback function that is called after a selection is completed.
+        It must have the signature::
 
-    @_api.rename_parameter("3.5", "maxdist", "handle_grab_distance")
-    @_api.rename_parameter("3.5", "marker_props", "handle_props")
-    @_api.delete_parameter("3.5", "drawtype")
-    @_api.delete_parameter("3.5", "lineprops")
-    def __init__(self, ax, onselect, drawtype='box',
-                 minspanx=0, minspany=0, useblit=False,
-                 lineprops=None, rectprops=None, spancoords='data',
-                 button=None, handle_grab_distance=10, handle_props=None,
-                 interactive=False, state_modifier_keys=None,
-                 drag_from_anywhere=False):
-        r"""
-        Parameters
-        ----------
-        ax : `~matplotlib.axes.Axes`
-            The parent axes for the widget.
+            def onselect(eclick: MouseEvent, erelease: MouseEvent)
 
-        onselect : function
-            A callback function that is called after a selection is completed.
-            It must have the signature::
+        where *eclick* and *erelease* are the mouse click and release
+        `.MouseEvent`\s that start and complete the selection.
 
-                def onselect(eclick: MouseEvent, erelease: MouseEvent)
+    drawtype : {"box", "line", "none"}, default: "box"
+        Whether to draw the full rectangle box, the diagonal line of the
+        rectangle, or nothing at all.
 
-            where *eclick* and *erelease* are the mouse click and release
-            `.MouseEvent`\s that start and complete the selection.
+    minspanx : float, default: 0
+        Selections with an x-span less than *minspanx* are ignored.
 
-        drawtype : {"box", "line", "none"}, default: "box"
-            Whether to draw the full rectangle box, the diagonal line of the
-            rectangle, or nothing at all.
+    minspany : float, default: 0
+        Selections with an y-span less than *minspany* are ignored.
 
-        minspanx : float, default: 0
-            Selections with an x-span less than *minspanx* are ignored.
+    useblit : bool, default: False
+        Whether to use blitting for faster drawing (if supported by the
+        backend).
 
-        minspany : float, default: 0
-            Selections with an y-span less than *minspany* are ignored.
+    lineprops : dict, optional
+        Properties with which the line is drawn, if ``drawtype == "line"``.
+        Default::
 
-        useblit : bool, default: False
-            Whether to use blitting for faster drawing (if supported by the
-            backend).
+            dict(color="black", linestyle="-", linewidth=2, alpha=0.5)
 
-        lineprops : dict, optional
-            Properties with which the line is drawn, if ``drawtype == "line"``.
-            Default::
+    rectprops : dict, optional
+        Properties with which the rectangle is drawn, if ``drawtype ==
+        "box"``.  Default::
 
-                dict(color="black", linestyle="-", linewidth=2, alpha=0.5)
+            dict(facecolor="red", edgecolor="black", alpha=0.2, fill=True)
 
-        rectprops : dict, optional
-            Properties with which the rectangle is drawn, if ``drawtype ==
-            "box"``.  Default::
+    spancoords : {"data", "pixels"}, default: "data"
+        Whether to interpret *minspanx* and *minspany* in data or in pixel
+        coordinates.
 
-                dict(facecolor="red", edgecolor="black", alpha=0.2, fill=True)
+    button : `.MouseButton`, list of `.MouseButton`, default: all buttons
+        Button(s) that trigger rectangle selection.
 
-        spancoords : {"data", "pixels"}, default: "data"
-            Whether to interpret *minspanx* and *minspany* in data or in pixel
-            coordinates.
+    handle_grab_distance : float, default: 10
+        Distance in pixels within which the interactive tool handles can be
+        activated.
 
-        button : `.MouseButton`, list of `.MouseButton`, default: all buttons
-            Button(s) that trigger rectangle selection.
+    handle_props : dict
+        Properties with which the interactive handles are drawn.
 
-        handle_grab_distance : float, default: 10
-            Distance in pixels within which the interactive tool handles can be
-            activated.
+    interactive : bool, default: False
+        Whether to draw a set of handles that allow interaction with the
+        widget after it is drawn.
 
-        handle_props : dict
-            Properties with which the interactive handles are drawn.
+    state_modifier_keys : dict, optional
+        Keyboard modifiers which affect the widget's behavior.  Values
+        amend the defaults.
 
-        interactive : bool, default: False
-            Whether to draw a set of handles that allow interaction with the
-            widget after it is drawn.
+        - "move": Move the existing shape, default: no modifier.
+        - "clear": Clear the current shape, default: "escape".
+        - "square": Makes the shape square, default: "shift".
+        - "center": Make the initial point the center of the shape,
+          default: "ctrl".
 
-        state_modifier_keys : dict, optional
-            Keyboard modifiers which affect the widget's behavior.  Values
-            amend the defaults.
+        "square" and "center" can be combined.
 
-            - "move": Move the existing shape, default: no modifier.
-            - "clear": Clear the current shape, default: "escape".
-            - "square": Makes the shape square, default: "shift".
-            - "center": Make the initial point the center of the shape,
-              default: "ctrl".
+    drag_from_anywhere : bool, optional
+        If `True`, the widget can be moved by clicking anywhere within
+        its bounds.
 
-            "square" and "center" can be combined.
+    Examples
+    --------
+    :doc:`/gallery/widgets/rectangle_selector`
+    """
 
-        drag_from_anywhere : bool, optional
-            If `True`, the widget can be moved by clicking anywhere within
-            its bounds.
-        """
+    _shape_klass = Rectangle
+
+    @_api.rename_parameter("3.5", "maxdist", "handle_grab_distance")
+    @_api.rename_parameter("3.5", "marker_props", "handle_props")
+    @_api.delete_parameter("3.5", "drawtype")
+    @_api.delete_parameter("3.5", "lineprops")
+    def __init__(self, ax, onselect, drawtype='box',
+                 minspanx=0, minspany=0, useblit=False,
+                 lineprops=None, rectprops=None, spancoords='data',
+                 button=None, handle_grab_distance=10, handle_props=None,
+                 interactive=False, state_modifier_keys=None,
+                 drag_from_anywhere=False):
         super().__init__(ax, onselect, useblit=useblit, button=button,
                          state_modifier_keys=state_modifier_keys)