Add implementation note

hannobraun · Apr 21, 2023 · 8d389c8 · 8d389c8
1 parent d906a0d
commit 8d389c8
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/crates/fj-kernel/src/operations/build/face.rs b/crates/fj-kernel/src/operations/build/face.rs
@@ -50,6 +50,12 @@ pub trait BuildFace {
 impl BuildFace for Face {}
 
 /// A polygon
+///
+/// # Implementation Note
+///
+/// Currently code that deals with `Polygon` might assume that the polygon has
+/// no holes. Unless you create a `Polygon` yourself, or modify a `Polygon`'s
+/// `face` field to have interior cycles, this should not affect you.
 pub struct Polygon<const D: usize> {
     /// The face that forms the polygon
     pub face: Face,