Update RadioButtons docs numpydoc style

timhoffm · timhoffm · commit bdddc15c1c02 · 2019-01-11T10:31:59.000+01:00
diff --git a/doc/api/widgets_api.rst b/doc/api/widgets_api.rst
@@ -2,6 +2,10 @@
 ``matplotlib.widgets``
 **********************
 
+.. inheritance-diagram:: matplotlib.widgets
+   :parts: 1
+
+
 .. automodule:: matplotlib.widgets
    :members:
    :undoc-members:
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -235,18 +235,17 @@ def _motion(self, event):
 
     def on_clicked(self, func):
         """
-        When the button is clicked, call this *func* with event.
+        Connect the callback function *func* to button click events.
 
-        A connection id is returned. It can be used to disconnect
-        the button from its callback.
+        Returns a connection id, which can be used to disconnect the callback.
         """
         cid = self.cnt
         self.observers[cid] = func
         self.cnt += 1
         return cid
 
     def disconnect(self, cid):
-        """remove the observer with connection id *cid*"""
+        """Remove the callback function with connection id *cid*."""
         try:
             del self.observers[cid]
         except KeyError:
@@ -648,9 +647,9 @@ def get_status(self):
 
     def on_clicked(self, func):
         """
-        When the button is clicked, call *func* with button label
+        Connect the callback function *func* to button click events.
 
-        A connection id is returned which can be used to disconnect
+        Returns a connection id, which can be used to disconnect the callback.
         """
         cid = self.cnt
         self.observers[cid] = func
@@ -974,40 +973,40 @@ class RadioButtons(AxesWidget):
     """
     A GUI neutral radio button.
 
-    For the buttons to remain responsive
-    you must keep a reference to this object.
-
-    The following attributes are exposed:
-
-     *ax*
-        The :class:`matplotlib.axes.Axes` instance the buttons are in
-
-     *activecolor*
-        The color of the button when clicked
+    For the buttons to remain responsive you must keep a reference to this
+    object.
 
-     *labels*
-        A list of :class:`matplotlib.text.Text` instances
+    Connect to the RadioButtons with the :meth:`on_clicked` method.
 
-     *circles*
-        A list of :class:`matplotlib.patches.Circle` instances
 
-     *value_selected*
-        A string listing the current value selected
+    Attributes
+    ----------
+    ax
+        The containing `~.axes.Axes` instance.
+    activecolor
+        The color of the selected button.
+    labels
+        A list of `~.text.Text` instances containing the button labels.
+    circles
+        A list of `~.patches.Circle` instances defining the buttons.
+    value_selected : str
+        The label text of the currently selected button.
 
-    Connect to the RadioButtons with the :meth:`on_clicked` method
     """
     def __init__(self, ax, labels, active=0, activecolor='blue'):
         """
-        Add radio buttons to :class:`matplotlib.axes.Axes` instance *ax*
-
-        *labels*
-            A len(buttons) list of labels as strings
+        Add radio buttons to an `~.axes.Axes`.
 
-        *active*
-            The index into labels for the button that is active
-
-        *activecolor*
-            The color of the button when clicked
+        Parameters
+        ----------
+        ax : `~matplotlib.axes.Axes`
+            The axes to add the buttons to.
+        labels : list of str
+            The button labels.
+        active : int
+            The index of the initially selected button.
+        activecolor : color
+            The color of the selected button.
         """
         AxesWidget.__init__(self, ax)
         self.activecolor = activecolor
@@ -1067,14 +1066,9 @@ def _clicked(self, event):
 
     def set_active(self, index):
         """
-        Trigger which radio button to make active.
-
-        *index* is an index into the original label list
-            that this object was constructed with.
-            Raise ValueError if the index is invalid.
+        Select button with number *index*.
 
         Callbacks will be triggered if :attr:`eventson` is True.
-
         """
         if 0 > index >= len(self.labels):
             raise ValueError("Invalid RadioButton index: %d" % index)
@@ -1098,17 +1092,17 @@ def set_active(self, index):
 
     def on_clicked(self, func):
         """
-        When the button is clicked, call *func* with button label
+        Connect the callback function *func* to button click events.
 
-        A connection id is returned which can be used to disconnect
+        Returns a connection id, which can be used to disconnect the callback.
         """
         cid = self.cnt
         self.observers[cid] = func
         self.cnt += 1
         return cid
 
     def disconnect(self, cid):
-        """remove the observer with connection id *cid*"""
+        """Remove the observer with connection id *cid*."""
         try:
             del self.observers[cid]
         except KeyError:
