Merge pull request #12463 from timhoffm/doc-cursor-data-event2

anntzer · web-flow · commit 50cb09b933dd · 2018-10-11T22:35:36.000+02:00
Document Artist.cursor_data() parameter
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -1117,9 +1117,9 @@ def get_cursor_data(self, event):
         Return the cursor data for a given event.
 
         .. note::
-            This method is intended to be overridden by artist subclasses
-            (or monkeypatched). As an end-user of Matplotlib you will most
-            likely not call this method yourself.
+            This method is intended to be overridden by artist subclasses.
+            As an end-user of Matplotlib you will most likely not call this
+            method yourself.
 
         Cursor data can be used by Artists to provide additional context
         information for a given event. The default implementation just returns
@@ -1132,6 +1132,10 @@ def get_cursor_data(self, event):
         The only current use case is displaying the z-value of an `.AxesImage`
         in the status bar of a plot window, while moving the mouse.
 
+        Parameters
+        ----------
+        event : `matplotlib.backend_bases.MouseEvent`
+
         See Also
         --------
         format_cursor_data
@@ -1144,9 +1148,9 @@ def format_cursor_data(self, data):
         Return a string representation of *data*.
 
         .. note::
-            This method is intended to be overridden by artist subclasses
-            (or monkeypatched). As an end-user of Matplotlib you will most
-            likely not call this method yourself.
+            This method is intended to be overridden by artist subclasses.
+            As an end-user of Matplotlib you will most likely not call this
+            method yourself.
 
         The default implementation converts ints and floats and arrays of ints
         and floats into a comma-separated string enclosed in square brackets.
