edit docs #1101

mozman · Jun 7, 2024 · f1f35d7 · f1f35d7
1 parent 9bae4db
commit f1f35d7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/src/ezdxf/math/clipping.py b/src/ezdxf/math/clipping.py
@@ -381,6 +381,11 @@ class InvertedClippingPolygon2d(ConcaveClippingPolygon2d):
     """This class represents an inverted clipping path.  Everything between the inner
     polygon and the outer extents is considered as inside.  The inner clipping path is
     an arbitrary 2D polygon.
+
+    .. Important:: 
+    
+        The `outer_bounds` must be larger than the content to clip to work correctly.
+
     """
 
     def __init__(self, inner_polygon: Iterable[Vec2], outer_bounds: BoundingBox2d):

diff --git a/src/ezdxf/tools/clipping_portal.py b/src/ezdxf/tools/clipping_portal.py
@@ -417,6 +417,10 @@ class InvertedClippingPolygon(ClippingPolygon):
     """Represents an arbitrary inverted clipping polygon.  Removes the geometry
     inside the clipping polygon.
 
+    .. Important:: 
+    
+        The `outer_bounds` must be larger than the content to clip to work correctly.
+
     """
 
     def __init__(self, vertices: Iterable[UVec], outer_bounds: BoundingBox2d) -> None: