From ce6f08042453c23177be9cda02a587fa8ea1b650 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Tue, 22 Mar 2022 15:31:25 +0100 Subject: [PATCH] Update documentation of `Approximation` --- fj-kernel/src/algorithms/approximation.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/fj-kernel/src/algorithms/approximation.rs b/fj-kernel/src/algorithms/approximation.rs index 906b9e409..b631b4435 100644 --- a/fj-kernel/src/algorithms/approximation.rs +++ b/fj-kernel/src/algorithms/approximation.rs @@ -4,7 +4,7 @@ use fj_math::{Point, Scalar, Segment}; use crate::topology::{Cycle, Face, Vertex}; -/// An approximation of an edge, multiple edges, or a face +/// The approximation of a face #[derive(Debug, PartialEq)] pub struct Approximation { /// All points that make up the approximation @@ -24,10 +24,10 @@ pub struct Approximation { } impl Approximation { - /// Compute an approximation for a face + /// Compute the approximation of a face /// /// `tolerance` defines how far the approximation is allowed to deviate from - /// the actual edges. + /// the actual face. pub fn new(face: &Face, tolerance: Scalar) -> Self { // Curved faces whose curvature is not fully defined by their edges // are not supported yet. For that reason, we can fully ignore `face`'s