Merge pull request #13721 from anntzer/overwritten-docstrings

jklymak · web-flow · commit 9fab0bd6df1e · 2019-03-23T07:53:47.000-07:00
Kill pyplot docstrings that get overwritten by @docstring.copy.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2297,7 +2297,6 @@ def ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=1,
         terminates input and any other key (not already used by the window
         manager) selects a point.
         """
-
         blocking_mouse_input = BlockingMouseInput(self,
                                                   mouse_add=mouse_add,
                                                   mouse_pop=mouse_pop,
@@ -2315,7 +2314,6 @@ def waitforbuttonpress(self, timeout=-1):
 
         If *timeout* is negative, does not timeout.
         """
-
         blocking_input = BlockingKeyMouseInput(self)
         return blocking_input(timeout=timeout)
 
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -702,28 +702,11 @@ def savefig(*args, **kwargs):
 
 @docstring.copy(Figure.ginput)
 def ginput(*args, **kwargs):
-    """
-    Blocking call to interact with the figure.
-
-    This will wait for *n* clicks from the user and return a list of the
-    coordinates of each click.
-
-    If *timeout* is negative, does not timeout.
-    """
     return gcf().ginput(*args, **kwargs)
 
 
 @docstring.copy(Figure.waitforbuttonpress)
 def waitforbuttonpress(*args, **kwargs):
-    """
-    Blocking call to interact with the figure.
-
-    This will wait for *n* key or mouse clicks from the user and
-    return a list containing True's for keyboard clicks and False's
-    for mouse clicks.
-
-    If *timeout* is negative, does not timeout.
-    """
     return gcf().waitforbuttonpress(*args, **kwargs)
 
 
