Skip to content

Commit

Permalink
Update documentation of validate
Browse files Browse the repository at this point in the history
  • Loading branch information
hannobraun committed Nov 9, 2022
1 parent 899b401 commit c874a9c
Showing 1 changed file with 3 additions and 15 deletions.
18 changes: 3 additions & 15 deletions crates/fj-kernel/src/validate/mod.rs
Original file line number Diff line number Diff line change
@@ -1,18 +1,4 @@
//! Infrastructure for validating shapes
//!
//! Validation enforces various constraints about shapes and the objects that
//! constitute them. These constraints fall into 4 categories:
//!
//! - **Coherence:** Local forms of objects must be consistent with their
//! canonical forms.
//! - **Geometric:** Comprises various object-specific constraints, for example
//! edges or faces might not be allowed to intersect.
//! - **Structural:** All other objects that an object references must be part
//! of the same shape.
//! - **Uniqueness:** Objects within a shape must be unique.
//!
//! Please note that not all of these validation categories are fully
//! implemented, as of this writing.
//! Infrastructure for validating objects
mod curve;
mod cycle;
Expand All @@ -36,6 +22,8 @@ use std::convert::Infallible;
use fj_math::Scalar;

/// Validate an object
///
/// This trait is used automatically when inserting an object into a store.
pub trait Validate: Sized {
/// The error that validation of the implementing type can result in
type Error: Into<ValidationError>;
Expand Down

0 comments on commit c874a9c

Please sign in to comment.