From e3a1ffde5b4d19fe4527e4111eabdad8783e2f9a Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Thu, 24 Oct 2024 18:55:04 +0200 Subject: [PATCH] Update doc comment --- crates/fj-core/src/geometry/geometry.rs | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/crates/fj-core/src/geometry/geometry.rs b/crates/fj-core/src/geometry/geometry.rs index ba16d45ee..83992f8cc 100644 --- a/crates/fj-core/src/geometry/geometry.rs +++ b/crates/fj-core/src/geometry/geometry.rs @@ -268,11 +268,18 @@ pub struct LocalCurveGeom { pub path: Path<2>, } -/// # A generator for curve geometry +/// # The representation of a curve's geometry /// /// Curves are represented by polylines, their uniform intermediate /// representation. However, this representation can be 2D (local to a surface) /// or 3D. This enum distinguishes between the two cases. +/// +/// ## Implementation Note +/// +/// There currently is an ongoing transition to a new geometry system. This type +/// represents new-style geometry. Its name is temporary, while the type +/// representing the old-style geometry is still taking up the more concise +/// name. pub enum CurveGeom2 { /// # The curve is defined locally on a surface Surface {