Update doc comment

hannobraun · Sep 13, 2023 · d36c6a8 · d36c6a8
1 parent ba9b8b1
commit d36c6a8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/crates/fj-core/src/algorithms/approx/curve/segment.rs b/crates/fj-core/src/algorithms/approx/curve/segment.rs
@@ -100,6 +100,10 @@ impl CurveApproxSegment {
     }
 
     /// Merge the provided segment into this one
+    ///
+    /// It there is a true overlap between both segments (as opposed to them
+    /// just touching), then the overlapping part is taken from the other
+    /// segment, meaning parts of this one get overwritten.
     pub fn merge(&mut self, other: &Self) {
         assert!(
             self.overlaps(other),