Skip to content

Fix some widget docstrings. #9600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 30, 2017
Merged

Fix some widget docstrings. #9600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions lib/matplotlib/widgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1259,11 +1259,10 @@ class Cursor(AxesWidget):
def __init__(self, ax, horizOn=True, vertOn=True, useblit=False,
**lineprops):
"""
Add a cursor to *ax*. If ``useblit=True``, use the backend-
dependent blitting features for faster updates (GTKAgg
only for now). *lineprops* is a dictionary of line properties.
Add a cursor to *ax*. If ``useblit=True``, use the backend-dependent
blitting features for faster updates. *lineprops* is a dictionary of
line properties.
"""
# TODO: Is the GTKAgg limitation still true?
AxesWidget.__init__(self, ax)

self.connect_event('motion_notify_event', self.onmove)
Expand Down Expand Up @@ -1685,8 +1684,7 @@ class SpanSelector(_SelectorWidget):
Visually select a min/max range on a single axis and call a function with
those values.

To guarantee that the selector remains responsive, keep a reference to
it.
To guarantee that the selector remains responsive, keep a reference to it.

In order to turn off the SpanSelector, set `span_selector.active=False`. To
turn it back on, set `span_selector.active=True`.
Expand All @@ -1705,7 +1703,7 @@ class SpanSelector(_SelectorWidget):

useblit : bool, default is False
If True, use the backend-dependent blitting features for faster
canvas updates. Only available for GTKAgg right now.
canvas updates.

rectprops : dict, default is None
Dictionary of :class:`matplotlib.patches.Patch` properties
Expand Down