From 62de46b5e267db203f5eac0922dbbfb6a46799f0 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Tue, 28 Jun 2022 17:53:51 +0200 Subject: [PATCH] Update doc comments --- crates/fj-kernel/src/objects/cycle.rs | 5 ----- crates/fj-kernel/src/objects/edge.rs | 5 ----- crates/fj-kernel/src/objects/vertex.rs | 5 ----- crates/fj-kernel/src/shape/local.rs | 7 ------- 4 files changed, 22 deletions(-) diff --git a/crates/fj-kernel/src/objects/cycle.rs b/crates/fj-kernel/src/objects/cycle.rs index 05da906ee..fe6c31ad3 100644 --- a/crates/fj-kernel/src/objects/cycle.rs +++ b/crates/fj-kernel/src/objects/cycle.rs @@ -11,11 +11,6 @@ use super::{Edge, Surface}; /// edge. The end of the last edge must connect to the beginning of the first /// one. /// -/// # Equality -/// -/// Please refer to [`crate::kernel::topology`] for documentation on the -/// equality of topological objects. -/// /// # Validation /// /// A cycle that is part of a [`Shape`] must be structurally sound. That means diff --git a/crates/fj-kernel/src/objects/edge.rs b/crates/fj-kernel/src/objects/edge.rs index 061e24962..9d62bfc10 100644 --- a/crates/fj-kernel/src/objects/edge.rs +++ b/crates/fj-kernel/src/objects/edge.rs @@ -11,11 +11,6 @@ use super::{Curve, Vertex}; /// An edge of a shape /// -/// # Equality -/// -/// Please refer to [`crate::kernel::topology`] for documentation on the -/// equality of topological objects. -/// /// # Validation /// /// An edge that is part of a [`Shape`] must be structurally sound. That means diff --git a/crates/fj-kernel/src/objects/vertex.rs b/crates/fj-kernel/src/objects/vertex.rs index 064987653..1f719a882 100644 --- a/crates/fj-kernel/src/objects/vertex.rs +++ b/crates/fj-kernel/src/objects/vertex.rs @@ -13,11 +13,6 @@ use crate::{builder::VertexBuilder, shape::Shape}; /// Points, on the other hand, might be used to approximate a shape for various /// purposes, without presenting any deeper truth about the shape's structure. /// -/// # Equality -/// -/// Please refer to [`crate::kernel::topology`] for documentation on the -/// equality of topological objects. -/// /// # Validation /// /// Vertices must be unique within a shape, meaning an identical vertex must not diff --git a/crates/fj-kernel/src/shape/local.rs b/crates/fj-kernel/src/shape/local.rs index e9df83444..2e6ec3159 100644 --- a/crates/fj-kernel/src/shape/local.rs +++ b/crates/fj-kernel/src/shape/local.rs @@ -5,13 +5,6 @@ use super::Object; /// This type is used by topological objects to reference other objects, while /// also keeping track of a local representation of that object, which is often /// more appropriate for various tasks. -/// -/// # Equality -/// -/// Since `LocalForm` is used by topological objects, its equality is defined in -/// terms that are useful to those objects. Two instances of `LocalForm` are -/// equal, if both the local and the canonical forms are equal. The equality of -/// the handle that refers to the canonical form is disregarded. #[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)] pub struct LocalForm { local: Local,