Document limitations of Path.contains_point() and clarify its semantics

timhoffm · timhoffm · commit 74aeb9110aea · 2020-11-12T01:49:09.000+01:00
diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
@@ -527,7 +527,7 @@ def contains_point(self, point, transform=None, radius=0.0):
         The current algorithm has some limitations:
 
         - The result is undefined for points exactly at the boundary
-          (including *radius*).
+          (i.e. at the path shifted by *radius/2*).
         - The result is undefined if there is no enclosed area, i.e. all
           vertices are on a straight line.
         - If bounding lines start to cross each other due to *radius* shift,
@@ -577,7 +577,7 @@ def contains_points(self, points, transform=None, radius=0.0):
         The current algorithm has some limitations:
 
         - The result is undefined for points exactly at the boundary
-          (including *radius*).
+          (i.e. at the path shifted by *radius/2*).
         - The result is undefined if there is no enclosed area, i.e. all
           vertices are on a straight line.
         - If bounding lines start to cross each other due to *radius* shift,
