From 5f629ca597e814ab93f76a3fedae37e19cf08278 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Fri, 21 Jun 2024 19:27:42 +0200 Subject: [PATCH] Improve documentation of curve approximation --- crates/fj-core/src/algorithms/approx/curve.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/crates/fj-core/src/algorithms/approx/curve.rs b/crates/fj-core/src/algorithms/approx/curve.rs index 697694233..c79d46641 100644 --- a/crates/fj-core/src/algorithms/approx/curve.rs +++ b/crates/fj-core/src/algorithms/approx/curve.rs @@ -126,7 +126,11 @@ fn approx_curve( CurveApprox { points } } -/// Approximation of [`Curve`], within a specific boundary +/// Approximation of a [`Curve`], within a specific boundary +/// +/// The approximation of the curve only includes points _within_ the boundary, +/// not those _on_ the boundary. Those boundary points are part of half-edge +/// approximation, which uses and includes curve approximation. #[derive(Clone)] pub struct CurveApprox { /// The points that approximate the curve within the boundary