Update documentation of Curve

hannobraun · May 13, 2022 · 1435249 · 1435249
1 parent 7de68a9
commit 1435249
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/crates/fj-kernel/src/geometry/curves.rs b/crates/fj-kernel/src/geometry/curves.rs
@@ -11,6 +11,10 @@ use crate::geometry;
 /// The nomenclature is inspired by Boundary Representation Modelling Techniques
 /// by Ian Stroud. "Curve" refers to unbounded one-dimensional geometry, while
 /// while edges are bounded portions of curves.
+///
+/// The `D` parameter defines the dimensions in which the curve is defined.
+/// Typically, only `2` or `3` make sense, which means the curve is defined on
+/// a surface or in a space, respectively.
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
 pub enum Curve<const D: usize> {
     /// A circle