DOC: numpydoc-ify widget.Slider.

Author: heathhenley

lib/matplotlib/widgets.py

@@ -266,91 +266,65 @@ class Slider(AxesWidget):
     """
     A slider representing a floating point range.
 
-    For the slider to remain responsive you must maintain a
-    reference to it.
-
-    The following attributes are defined
-      *ax*        : the slider :class:`matplotlib.axes.Axes` instance
-
-      *val*       : the current slider value
-
-      *vline*     : a :class:`matplotlib.lines.Line2D` instance
-                     representing the initial value of the slider
-
-      *poly*      : A :class:`matplotlib.patches.Polygon` instance
-                     which is the slider knob
-
-      *valfmt*    : the format string for formatting the slider text
-
-      *label*     : a :class:`matplotlib.text.Text` instance
-                     for the slider label
-
-      *closedmin* : whether the slider is closed on the minimum
-
-      *closedmax* : whether the slider is closed on the maximum
-
-      *slidermin* : another slider - if not *None*, this slider must be
-                     greater than *slidermin*
-
-      *slidermax* : another slider - if not *None*, this slider must be
-                     less than *slidermax*
-
-      *dragging*  : allow for mouse dragging on slider
+    Create a slider from *valmin* to *valmax* in axes *ax*. For the slider to
+    remain responsive you must maintain a reference to it.
 
     Call :meth:`on_changed` to connect to the slider event
     """
     def __init__(self, ax, label, valmin, valmax, valinit=0.5, valfmt='%1.2f',
                  closedmin=True, closedmax=True, slidermin=None,
                  slidermax=None, dragging=True, **kwargs):
         """
-        Create a slider from *valmin* to *valmax* in axes *ax*.
-
-        Additional kwargs are passed on to ``self.poly`` which is the
-        :class:`matplotlib.patches.Rectangle` that draws the slider
-        knob.  See the :class:`matplotlib.patches.Rectangle` documentation for
-        valid property names (e.g., *facecolor*, *edgecolor*, *alpha*, ...).
-
         Parameters
         ----------
         ax : Axes
-            The Axes to put the slider in
+            The Axes to put the slider in.
 
         label : str
-            Slider label
+            Slider label.
 
         valmin : float
-            The minimum value of the slider
+            The minimum value of the slider.
 
         valmax : float
-            The maximum value of the slider
-
-        valinit : float
-            The slider initial position
+            The maximum value of the slider.
 
-        label : str
-            The slider label
+        valinit : float, optional
+            The slider initial position.
+	    Default: 0.5
 
-        valfmt : str
-            Used to format the slider value, fprint format string
+        valfmt : str, optional
+            Used to format the slider value, fprint format string.
+	    Default: '%1.2f' 
 
-        closedmin : bool
-            Indicate whether the slider interval is closed on the bottom
+        closedmin : bool, optional
+            Indicate whether the slider interval is closed on the bottom.
+            Default: True
 
-        closedmax : bool
-            Indicate whether the slider interval is closed on the top
+        closedmax : bool, optional
+            Indicate whether the slider interval is closed on the top.
+            Default: True
 
-        slidermin : Slider or None
+        slidermin : Slider, optional
             Do not allow the current slider to have a value less than
-            `slidermin`
+            `slidermin.val`.
+            Default: None
 
-        slidermax : Slider or None
+        slidermax : Slider, optional
             Do not allow the current slider to have a value greater than
-            `slidermax`
+            `slidermax.val`.
+            Default: None
 
+        dragging : bool, optional
+            If True the slider can be dragged by the mouse.
+            Default: True
 
-        dragging : bool
-            if the slider can be dragged by the mouse
-
+        Notes
+        ----------
+        Additional kwargs are passed on to ``self.poly`` which is the
+        :class:`matplotlib.patches.Rectangle` that draws the slider
+        knob.  See the :class:`matplotlib.patches.Rectangle` documentation for
+        valid property names (e.g., *facecolor*, *edgecolor*, *alpha*, ...).
         """
         AxesWidget.__init__(self, ax)