DOC : improved docs in widgets.py

tacaswell · tacaswell · commit 121556637cd0 · 2014-06-10T08:33:33.000-04:00
- corrected docstring in Slider.__init__
 - feedback on previous commit
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -73,8 +73,10 @@ class AxesWidget(Widget):
     """Widget that is connected to a single
     :class:`~matplotlib.axes.Axes`.
 
-    To guarantee that the widgets stay responsive maintain a reference
-    to them.  This is necessary because the callback registry
+    To guarantee that the widget remains responsive and not garbage-collected,
+    a reference to the object should be maintained by the user.
+
+    This is necessary because the callback registry
     maintains only weak-refs to the functions, which are member
     functions of the widget.  If there are no references to the widget
     object it may be garbage collected which will disconnect the
@@ -123,7 +125,7 @@ class Button(AxesWidget):
     A GUI neutral button.
 
     For the button to remain responsive
-    you much keep a reference to it.
+    you must keep a reference to it.
 
     The following attributes are accessible
 
@@ -294,6 +296,18 @@ def __init__(self, ax, label, valmin, valmax, valinit=0.5, valfmt='%1.2f',
 
         Parameters
         ----------
+        ax : Axes
+            The Axes to put the slider in
+
+        label : str
+            Slider label
+
+        valmin : float
+            The minimum value of the slider
+
+        valmax : float
+            The maximum value of the slider
+
         valinit : float
             The slider initial position
 
@@ -304,13 +318,19 @@ def __init__(self, ax, label, valmin, valmax, valinit=0.5, valfmt='%1.2f',
             Used to format the slider value, fprint format string
 
         closedmin : bool
+            Indicate whether the slider interval is closed on the bottom
+
         closedmax : bool
-            Indicate whether the slider interval is closed
+            Indicate whether the slider interval is closed on the top
+
+        slidermin : Slider or None
+            Do not allow the current slider to have a value less than
+            `slidermin`
+
+        slidermax : Slider or None
+            Do not allow the current slider to have a value greater than
+            `slidermax`
 
-        slidermin : float
-        slidermax : float
-            Used to constrain the value of this slider to the values
-            of other sliders.
 
         dragging : bool
             if the silder can be dragged by the mouse
@@ -949,7 +969,7 @@ class MultiCursor(Widget):
     Provide a vertical (default) and/or horizontal line cursor shared between
     multiple axes.
 
-     For the cursor to remain responsive you much keep a reference to
+    For the cursor to remain responsive you much keep a reference to
     it.
 
     Example usage::
