Merge pull request #16133 from anntzer/line2dcontains

jklymak · web-flow · commit 09555538c5ae · 2020-01-07T10:56:46.000-08:00
Reword docstring of Line2D.contains.
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -418,12 +418,12 @@ def __init__(self, xdata, ydata,
 
     def contains(self, mouseevent):
         """
-        Test whether the mouse event occurred on the line.  The pick
-        radius determines the precision of the location test (usually
-        within five points of the value).  Use
-        :meth:`~matplotlib.lines.Line2D.get_pickradius` or
-        :meth:`~matplotlib.lines.Line2D.set_pickradius` to view or
-        modify it.
+        Test whether *mouseevent* occurred on the line.
+
+        An event is deemed to have occurred "on" the line if it is less
+        than ``self.pickradius`` (default: 5 points) away from it.  Use
+        `~.Line2D.get_pickradius` or `~.Line2D.set_pickradius` to get or set
+        the pick radius.
 
         Parameters
         ----------
