Suggested changes to ginput docstring

dstansby · dstansby · commit 922ef5fb992c · 2017-03-02T12:22:47.000Z
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1827,9 +1827,9 @@ def subplots_adjust(self, *args, **kwargs):
     def ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=1,
                mouse_pop=3, mouse_stop=2):
         """
-        Blocking call to interact with a figure. This will wait for *n*
-        clicks from the user and return a list of the coordinates of each
-        click.
+        Blocking call to interact with a figure. Wait until the user clicks *n*
+        times on the figure, and return the coordinates of each click in a
+        list.
 
         The buttons used for the various actions (adding points, removing
         points, terminating the inputs) can be overriden via the
@@ -1839,22 +1839,20 @@ def ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=1,
 
         Parameters
         ----------
-        n : int, optional
+        n : int, optional, default: 1
             Number of mouse clicks to accumulate. If negative, accumulate
-            clicks until the input is terminated manually. Default is 1.
-        timeout : scalar, optional
+            clicks until the input is terminated manually.
+        timeout : scalar, optional, default: 30
             Number of seconds to wait before timing out. If zero or negative
-            will never timeout. Default is 30.
-        show_clicks : bool, optional
-            If True, show a red cross at the location of each click. Default is
-            False.
-        mouse_add : int, one of (1, 2, 3), optional
-            Mouse button used to add points. Default is 1 (left click)
-        mouse_pop : int, one of (1, 2, 3), optional
-            Mouse button used to remove the most recently added point. Default
-            is 3 (right click)
-        mouse_stop : int, one of (1, 2, 3), optional
-            Mouse button used to stop input. Default is 2 (middle click)
+            will never timeout.
+        show_clicks : bool, optional, default: False
+            If True, show a red cross at the location of each click
+        mouse_add : int, one of (1, 2, 3), optional, default: 1 (left click)
+            Mouse button used to add points
+        mouse_pop : int, one of (1, 2, 3), optional, default: 3 (right click)
+            Mouse button used to remove the most recently added point
+        mouse_stop : int, one of (1, 2, 3), optional, default: 2 (middle click)
+            Mouse button used to stop input
 
         Returns
         -------
