Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 380a894

Browse filesBrowse files
committed
Merge pull request #5484 from flothesof/patch-1
DOC: fix small typos in documentation
2 parents dda8097 + fef5d49 commit 380a894
Copy full SHA for 380a894

File tree

Expand file treeCollapse file tree

1 file changed

+31
-31
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+31
-31
lines changed

‎lib/matplotlib/widgets.py

Copy file name to clipboardExpand all lines: lib/matplotlib/widgets.py
+31-31Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
"""
2-
GUI Neutral widgets
2+
GUI neutral widgets
33
===================
44
55
Widgets that are designed to work for any of the GUI backends.
6-
All of these widgets require you to predefine an :class:`matplotlib.axes.Axes`
6+
All of these widgets require you to predefine a :class:`matplotlib.axes.Axes`
77
instance and pass that as the first arg. matplotlib doesn't try to
88
be too smart with respect to layout -- you will have to figure out how
99
wide and tall you want your Axes to be to accommodate your widget.
@@ -30,9 +30,9 @@ class LockDraw(object):
3030
desirable under all circumstances, like when the toolbar is in
3131
zoom-to-rect mode and drawing a rectangle. The module level "lock"
3232
allows someone to grab the lock and prevent other widgets from
33-
drawing. Use ``matplotlib.widgets.lock(someobj)`` to pr
33+
drawing. Use ``matplotlib.widgets.lock(someobj)`` to prevent
34+
other widgets from drawing while you're interacting with the canvas.
3435
"""
35-
# FIXME: This docstring ends abruptly without...
3636

3737
def __init__(self):
3838
self._owner = None
@@ -124,7 +124,7 @@ def connect_event(self, event, callback):
124124
"""Connect callback with an event.
125125
126126
This should be used in lieu of `figure.canvas.mpl_connect` since this
127-
function stores call back ids for later clean up.
127+
function stores callback ids for later clean up.
128128
"""
129129
cid = self.canvas.mpl_connect(event, callback)
130130
self.cids.append(cid)
@@ -139,8 +139,7 @@ class Button(AxesWidget):
139139
"""
140140
A GUI neutral button.
141141
142-
For the button to remain responsive
143-
you must keep a reference to it.
142+
For the button to remain responsive you must keep a reference to it.
144143
145144
The following attributes are accessible
146145
@@ -244,9 +243,10 @@ def _motion(self, event):
244243

245244
def on_clicked(self, func):
246245
"""
247-
When the button is clicked, call this *func* with event
246+
When the button is clicked, call this *func* with event.
248247
249-
A connection id is returned which can be used to disconnect
248+
A connection id is returned. It can be used to disconnect
249+
the button from its callback.
250250
"""
251251
cid = self.cnt
252252
self.observers[cid] = func
@@ -265,8 +265,8 @@ class Slider(AxesWidget):
265265
"""
266266
A slider representing a floating point range.
267267
268-
For the slider
269-
to remain responsive you must maintain a reference to it.
268+
For the slider to remain responsive you must maintain a
269+
reference to it.
270270
271271
The following attributes are defined
272272
*ax* : the slider :class:`matplotlib.axes.Axes` instance
@@ -304,10 +304,10 @@ def __init__(self, ax, label, valmin, valmax, valinit=0.5, valfmt='%1.2f',
304304
"""
305305
Create a slider from *valmin* to *valmax* in axes *ax*.
306306
307-
additional kwargs are passed on to ``self.poly`` which is the
308-
:class:`matplotlib.patches.Rectangle` which draws the slider
309-
knob. See the :class:`matplotlib.patches.Rectangle` documentation
310-
valid property names (e.g., *facecolor*, *edgecolor*, *alpha*, ...)
307+
Additional kwargs are passed on to ``self.poly`` which is the
308+
:class:`matplotlib.patches.Rectangle` that draws the slider
309+
knob. See the :class:`matplotlib.patches.Rectangle` documentation for
310+
valid property names (e.g., *facecolor*, *edgecolor*, *alpha*, ...).
311311
312312
Parameters
313313
----------
@@ -476,7 +476,7 @@ class CheckButtons(AxesWidget):
476476
"""
477477
A GUI neutral radio button.
478478
479-
For the check buttons to remain responsive you much keep a
479+
For the check buttons to remain responsive you must keep a
480480
reference to this object.
481481
482482
The following attributes are exposed
@@ -624,12 +624,12 @@ def disconnect(self, cid):
624624

625625
class RadioButtons(AxesWidget):
626626
"""
627-
A GUI neutral radio button
627+
A GUI neutral radio button.
628628
629629
For the buttons to remain responsive
630-
you much keep a reference to this object.
630+
you must keep a reference to this object.
631631
632-
The following attributes are exposed
632+
The following attributes are exposed:
633633
634634
*ax*
635635
The :class:`matplotlib.axes.Axes` instance the buttons are in
@@ -772,16 +772,16 @@ def disconnect(self, cid):
772772

773773
class SubplotTool(Widget):
774774
"""
775-
A tool to adjust to subplot params of a :class:`matplotlib.figure.Figure`
775+
A tool to adjust the subplot params of a :class:`matplotlib.figure.Figure`.
776776
"""
777777
def __init__(self, targetfig, toolfig):
778778
"""
779779
*targetfig*
780-
The figure instance to adjust
780+
The figure instance to adjust.
781781
782782
*toolfig*
783783
The figure instance to embed the subplot tool into. If
784-
None, a default figure will be created. If you are using
784+
*None*, a default figure will be created. If you are using
785785
this from the GUI
786786
"""
787787
# FIXME: The docstring seems to just abruptly end without...
@@ -921,9 +921,9 @@ def funchspace(self, val):
921921

922922
class Cursor(AxesWidget):
923923
"""
924-
A horizontal and vertical line span the axes that and move with
925-
the pointer. You can turn off the hline or vline spectively with
926-
the attributes
924+
A horizontal and vertical line that spans the axes and moves with
925+
the pointer. You can turn off the hline or vline respectively with
926+
the following attributes:
927927
928928
*horizOn*
929929
Controls the visibility of the horizontal line
@@ -933,7 +933,7 @@ class Cursor(AxesWidget):
933933
934934
and the visibility of the cursor itself with the *visible* attribute.
935935
936-
For the cursor to remain responsive you much keep a reference to
936+
For the cursor to remain responsive you must keep a reference to
937937
it.
938938
"""
939939
def __init__(self, ax, horizOn=True, vertOn=True, useblit=False,
@@ -1018,7 +1018,7 @@ class MultiCursor(Widget):
10181018
Provide a vertical (default) and/or horizontal line cursor shared between
10191019
multiple axes.
10201020
1021-
For the cursor to remain responsive you much keep a reference to
1021+
For the cursor to remain responsive you must keep a reference to
10221022
it.
10231023
10241024
Example usage::
@@ -1366,7 +1366,7 @@ class SpanSelector(_SelectorWidget):
13661366
"""
13671367
Select a min/max range of the x or y axes for a matplotlib Axes.
13681368
1369-
For the selector to remain responsive you much keep a reference to
1369+
For the selector to remain responsive you must keep a reference to
13701370
it.
13711371
13721372
Example usage::
@@ -1630,7 +1630,7 @@ class RectangleSelector(_SelectorWidget):
16301630
"""
16311631
Select a rectangular region of an axes.
16321632
1633-
For the cursor to remain responsive you much keep a reference to
1633+
For the cursor to remain responsive you must keep a reference to
16341634
it.
16351635
16361636
Example usage::
@@ -2045,7 +2045,7 @@ class EllipseSelector(RectangleSelector):
20452045
"""
20462046
Select an elliptical region of an axes.
20472047
2048-
For the cursor to remain responsive you much keep a reference to
2048+
For the cursor to remain responsive you must keep a reference to
20492049
it.
20502050
20512051
Example usage::
@@ -2115,7 +2115,7 @@ def _rect_bbox(self):
21152115
class LassoSelector(_SelectorWidget):
21162116
"""Selection curve of an arbitrary shape.
21172117
2118-
For the selector to remain responsive you much keep a reference to
2118+
For the selector to remain responsive you must keep a reference to
21192119
it.
21202120
21212121
The selected path can be used in conjunction with

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.