From 379cd35a897c292fef497a637f2e19d96c82f642 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Mon, 12 Aug 2024 20:37:40 +0200 Subject: [PATCH] Document expected order `add_joined_edges` --- crates/fj-core/src/operations/join/cycle.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/crates/fj-core/src/operations/join/cycle.rs b/crates/fj-core/src/operations/join/cycle.rs index a6d232c72..9a1feb038 100644 --- a/crates/fj-core/src/operations/join/cycle.rs +++ b/crates/fj-core/src/operations/join/cycle.rs @@ -22,9 +22,13 @@ pub trait JoinCycle { /// joins the new half-edge to the provided one, and adds the new half-edge /// to the cycle. /// - /// The geometry for each new half-edge needs to be provided as well. + /// Expects the provided half-edges to be in an unnatural order: /// - /// Also requires the surface that the cycle is defined in. + /// - This is the opposite order that they would appear in, in a cycle. + /// - Meaning each half-edge ends where the _previous_ one starts. + /// + /// The geometry for each new half-edge needs to be provided as well. Also + /// requires the surface that the cycle is defined in. #[must_use] fn add_joined_edges( &self,