From c00ac2eab8b1290977d72c004309137bd7834d89 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Wed, 22 Feb 2023 13:23:03 +0100 Subject: [PATCH] Update documentation of `GlobalEdge` --- crates/fj-kernel/src/objects/full/edge.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/crates/fj-kernel/src/objects/full/edge.rs b/crates/fj-kernel/src/objects/full/edge.rs index be36a9239..c25653416 100644 --- a/crates/fj-kernel/src/objects/full/edge.rs +++ b/crates/fj-kernel/src/objects/full/edge.rs @@ -105,12 +105,15 @@ impl fmt::Display for HalfEdge { } } -/// An edge, defined in global (3D) coordinates +/// An undirected edge, defined in global (3D) coordinates /// /// In contrast to [`HalfEdge`], `GlobalEdge` is undirected, meaning it has no /// defined direction, and its vertices have no defined order. This means it can /// be used to determine whether two [`HalfEdge`]s map to the same `GlobalEdge`, /// regardless of their direction. +/// +/// See [`HalfEdge`]'s documentation for more information on the relationship +/// between [`HalfEdge`] and `GlobalEdge`. #[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)] pub struct GlobalEdge { curve: HandleWrapper,