From 340226edd51d1ed4fcf8ba72f0d04219c701f348 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Tue, 23 May 2023 09:27:11 +0200 Subject: [PATCH] Update crate-level doc comments --- crates/fj-export/src/lib.rs | 12 ++++-------- crates/fj-interop/src/lib.rs | 13 +++++-------- crates/fj-kernel/src/lib.rs | 14 +++++--------- crates/fj-math/src/lib.rs | 14 ++++++-------- crates/fj-viewer/src/lib.rs | 12 ++++-------- 5 files changed, 24 insertions(+), 41 deletions(-) diff --git a/crates/fj-export/src/lib.rs b/crates/fj-export/src/lib.rs index cf0dee687..dcb7fab92 100644 --- a/crates/fj-export/src/lib.rs +++ b/crates/fj-export/src/lib.rs @@ -1,14 +1,10 @@ //! # Fornjot Exporter //! -//! This library is part of the [Fornjot] ecosystem. Fornjot is an open-source, -//! code-first CAD application; and collection of libraries that make up the CAD -//! application, but can be used independently. +//! [Fornjot] is an early-stage b-rep CAD kernel written in Rust. The kernel is +//! split into multiple libraries that can be used semi-independently, and this +//! is one of those. //! -//! This library is an internal component of Fornjot. It is not relevant to end -//! users that just want to create CAD models. -//! -//! The purpose of this library is to export Fornjot models to external file -//! formats. +//! This library exports Fornjot models to external file formats. //! //! [Fornjot]: https://www.fornjot.app/ diff --git a/crates/fj-interop/src/lib.rs b/crates/fj-interop/src/lib.rs index cea11ceb3..e2f455476 100644 --- a/crates/fj-interop/src/lib.rs +++ b/crates/fj-interop/src/lib.rs @@ -1,14 +1,11 @@ //! # Fornjot Interop Types //! -//! This library is part of the [Fornjot] ecosystem. Fornjot is an open-source, -//! code-first CAD application; and collection of libraries that make up the CAD -//! application, but can be used independently. +//! [Fornjot] is an early-stage b-rep CAD kernel written in Rust. The kernel is +//! split into multiple libraries that can be used semi-independently, and this +//! is one of those. //! -//! This library is an internal component of Fornjot. It is not relevant to end -//! users that just want to create CAD models. -//! -//! The purpose of this library is to define types that allow other components -//! of the Fornjot ecosystem to interoperate, without depending on each other. +//! This library defines types that allow other components of Fornjot to +//! interoperate, without having to depend on each other. //! //! [Fornjot]: https://www.fornjot.app/ diff --git a/crates/fj-kernel/src/lib.rs b/crates/fj-kernel/src/lib.rs index 0996e6dd3..cf38b263d 100644 --- a/crates/fj-kernel/src/lib.rs +++ b/crates/fj-kernel/src/lib.rs @@ -1,15 +1,11 @@ //! # Fornjot CAD Kernel //! -//! This library is part of the [Fornjot] ecosystem. Fornjot is an open-source, -//! code-first CAD application; and collection of libraries that make up the CAD -//! application, but can be used independently. +//! [Fornjot] is an early-stage b-rep CAD kernel written in Rust. The kernel is +//! split into multiple libraries that can be used semi-independently, and this +//! is one of those. //! -//! This library is an internal component of Fornjot. It is not relevant to end -//! users that just want to create CAD models. -//! -//! The CAD kernel is the core of Fornjot: the geometry, the topology, and the -//! algorithms that handle them. It is separate from the CAD application, and -//! could be used in other applications. +//! This library defines geometric and topological primitives, and the +//! algorithms that operate on them. //! //! //! ## Design Principle diff --git a/crates/fj-math/src/lib.rs b/crates/fj-math/src/lib.rs index feb8c3fea..dea470a8c 100644 --- a/crates/fj-math/src/lib.rs +++ b/crates/fj-math/src/lib.rs @@ -1,16 +1,14 @@ //! # Fornjot Math Library //! -//! This library is part of the [Fornjot] ecosystem. Fornjot is an open-source, -//! code-first CAD application; and collection of libraries that make up the CAD -//! application, but can be used independently. +//! [Fornjot] is an early-stage b-rep CAD kernel written in Rust. The kernel is +//! split into multiple libraries that can be used semi-independently, and this +//! is one of those. //! -//! This library is an internal component of Fornjot. It is not relevant to end -//! users that just want to create CAD models. -//! -//! This crates provides basic math types for the Fornjot ecosystem. It is built -//! on [nalgebra] and [Parry], but provides an interface that is specifically +//! This library provides basic math types for Fornjot. It is built on +//! [nalgebra] and [Parry], but provides an interface that is specifically //! tailored to the needs of Fornjot. //! +//! //! ## Failing [`From`]/[`Into`] implementations //! //! Please note that any [`From`]/[`Into`] implementation that convert floating diff --git a/crates/fj-viewer/src/lib.rs b/crates/fj-viewer/src/lib.rs index f46c8de84..c9d888503 100644 --- a/crates/fj-viewer/src/lib.rs +++ b/crates/fj-viewer/src/lib.rs @@ -1,14 +1,10 @@ //! # Fornjot Model Viewer //! -//! This library is part of the [Fornjot] ecosystem. Fornjot is an open-source, -//! code-first CAD application; and collection of libraries that make up the CAD -//! application, but can be used independently. +//! [Fornjot] is an early-stage b-rep CAD kernel written in Rust. The kernel is +//! split into multiple libraries that can be used semi-independently, and this +//! is one of those. //! -//! This library is an internal component of Fornjot. It is not relevant to end -//! users that just want to create CAD models. -//! -//! This library provides a model viewer which allows basic navigation and -//! rendering of generated models. +//! This library provides a viewer for Fornjot models. //! //! [Fornjot]: https://www.fornjot.app/