From aa96f3eac10dd33f1217a7345b6374f9e830c1a2 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Mon, 21 Feb 2022 16:06:46 +0100 Subject: [PATCH] Update doc comment --- src/kernel/topology/vertices.rs | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/kernel/topology/vertices.rs b/src/kernel/topology/vertices.rs index 87c7ce924..3643d98a5 100644 --- a/src/kernel/topology/vertices.rs +++ b/src/kernel/topology/vertices.rs @@ -72,8 +72,13 @@ impl Vertex<3> { impl Vertex<1> { /// Create a transformed vertex /// - /// The transformed vertex has its canonical form transformed by the - /// transformation provided, but is otherwise identical. + /// This is a 3D transformation that transforms the canonical form of the + /// vertex, but leaves the location untouched. Since `self` is a + /// 1-dimensional vertex, transforming the location is not possible. + /// + /// And, presumably, also not necessary, as this is likely part of a larger + /// transformation that also transforms the curve the vertex is on. Making + /// sure this is the case, is the responsibility of the caller. #[must_use] pub fn transform(mut self, transform: &Transform) -> Self { self.canonical = transform.transform_point(&self.canonical);