Document that clip_to_bbox requires closed paths.

mdboom · mdboom · commit ddf09f2f67b6 · 2013-02-24T12:13:50.000-05:00
diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
@@ -714,6 +714,9 @@ def clip_to_bbox(self, bbox, inside=True):
         """
         Clip the path to the given bounding box.
 
+        The path must be made up of one or more closed polygons.  This
+        algorithm will not behave correctly for unclosed paths.
+
         If *inside* is `True`, clip to the inside of the box, otherwise
         to the outside of the box.
         """
