Add some docs.

georust · Oct 25, 2024 · 65b936c · 65b936c
1 parent 996cb46
commit 65b936c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/geo/src/algorithm/bool_ops/i_overlay_integration.rs b/geo/src/algorithm/bool_ops/i_overlay_integration.rs
@@ -11,6 +11,7 @@ pub trait BoolOpsCoord<T>: Copy {
     fn y(&self) -> T;
 }
 
+/// A geometry coordinate number suitable for performing geometric boolean operations.
 pub trait BoolOpsNum: GeoNum {
     type CoordType: BoolOpsCoord<Self>;
     type OverlayType: BoolOpsOverlay<CoordType = Self::CoordType>;

diff --git a/geo/src/algorithm/bool_ops/mod.rs b/geo/src/algorithm/bool_ops/mod.rs
@@ -29,6 +29,13 @@ use crate::geometry::{LineString, MultiLineString, MultiPolygon, Polygon};
 pub trait BooleanOps {
     type Scalar: BoolOpsNum;
 
+    /// The exterior and interior rings of the geometry.
+    ///
+    /// It doesn't particularly matter which order they are in, as the topology algorithm counts crossings
+    /// to determine the interior and exterior of the polygon.
+    ///
+    /// It is required that the rings are from valid geometries, that the rings not overlap.
+    /// In the case of a MultiPolygon, this requires that none of its polygon's interiors may overlap.
     fn rings(&self) -> impl Iterator<Item = &LineString<Self::Scalar>>;
 
     fn boolean_op(