From d80414476a5df36f46f68532e6e0db4014b154b5 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Mon, 12 Aug 2024 20:43:04 +0200 Subject: [PATCH] Add comment to `add_joined_half_edges` --- crates/fj-core/src/operations/join/cycle.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/crates/fj-core/src/operations/join/cycle.rs b/crates/fj-core/src/operations/join/cycle.rs index 41628a7d6..8f2cc5437 100644 --- a/crates/fj-core/src/operations/join/cycle.rs +++ b/crates/fj-core/src/operations/join/cycle.rs @@ -106,6 +106,10 @@ impl JoinCycle for Cycle { let half_edges = half_edges .into_iter() .circular_tuple_windows() + // If you're confused about the naming of `next_half_edge` and/or + // the relative order of `half_edge`/`next_half_edge`, please refer + // to the documentation of this method. This matches the order it + // expects half-edges in. .map(|((next_half_edge, _), (half_edge, curve_geom))| { let half_edge = HalfEdge::unjoined(core) .update_curve(|_, _| half_edge.curve().clone(), core)