From c848dbec9c52a5511d180406ff986368fef14b5d Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Tue, 20 Jun 2023 10:25:03 +0200 Subject: [PATCH] Update documentation of `algorithms` module --- crates/fj-core/src/algorithms/mod.rs | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/crates/fj-core/src/algorithms/mod.rs b/crates/fj-core/src/algorithms/mod.rs index c7fa369d4..d98821357 100644 --- a/crates/fj-core/src/algorithms/mod.rs +++ b/crates/fj-core/src/algorithms/mod.rs @@ -1,7 +1,14 @@ -//! Collection of algorithms that are used by the kernel +//! Collection of algorithms that operate on geometry //! //! Algorithmic code is collected in this module, to keep other modules focused //! on their respective purpose. +//! +//! # Implementation Note +//! +//! This module exists in a bit of an in-between state, as some of the things +//! that are still here are probably better places in the [`operations`] module. +//! +//! [`operations`]: crate::operations pub mod approx; pub mod bounding_volume;