Skip to content

Commit

Permalink
Kill pyplot docstrings that get overwritten by @docstring.copy.
Browse files Browse the repository at this point in the history
The docstrings of the Figure methods are more complete anyways.
  • Loading branch information
anntzer committed Mar 20, 2019
1 parent 9faf231 commit 1966f16
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 19 deletions.
2 changes: 0 additions & 2 deletions lib/matplotlib/figure.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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)

Expand Down
17 changes: 0 additions & 17 deletions lib/matplotlib/pyplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)


Expand Down

0 comments on commit 1966f16

Please sign in to comment.