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 076c0db

Browse filesBrowse files
committed
Document Artist.cursor_data() parameter
1 parent f93222a commit 076c0db
Copy full SHA for 076c0db

File tree

Expand file treeCollapse file tree

1 file changed

+10
-6
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+10
-6
lines changed

‎lib/matplotlib/artist.py

Copy file name to clipboardExpand all lines: lib/matplotlib/artist.py
+10-6Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1117,9 +1117,9 @@ def get_cursor_data(self, event):
11171117
Return the cursor data for a given event.
11181118
11191119
.. note::
1120-
This method is intended to be overridden by artist subclasses
1121-
(or monkeypatched). As an end-user of Matplotlib you will most
1122-
likely not call this method yourself.
1120+
This method is intended to be overridden by artist subclasses.
1121+
As an end-user of Matplotlib you will most likely not call this
1122+
method yourself.
11231123
11241124
Cursor data can be used by Artists to provide additional context
11251125
information for a given event. The default implementation just returns
@@ -1132,6 +1132,10 @@ def get_cursor_data(self, event):
11321132
The only current use case is displaying the z-value of an `.AxesImage`
11331133
in the status bar of a plot window, while moving the mouse.
11341134
1135+
Parameters
1136+
----------
1137+
event : `matplotlib.backend_bases.MouseEvent`
1138+
11351139
See Also
11361140
--------
11371141
format_cursor_data
@@ -1144,9 +1148,9 @@ def format_cursor_data(self, data):
11441148
Return a string representation of *data*.
11451149
11461150
.. note::
1147-
This method is intended to be overridden by artist subclasses
1148-
(or monkeypatched). As an end-user of Matplotlib you will most
1149-
likely not call this method yourself.
1151+
This method is intended to be overridden by artist subclasses.
1152+
As an end-user of Matplotlib you will most likely not call this
1153+
method yourself.
11501154
11511155
The default implementation converts ints and floats and arrays of ints
11521156
and floats into a comma-separated string enclosed in square brackets.

0 commit comments

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