Update documentation of update operations

The old versions were no longer correct, due to the changes to the `Handles` API.
hannobraun · Nov 7, 2023 · 26b8f87 · 26b8f87
1 parent daa6cc9
commit 26b8f87
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 25 deletions.
diff --git a/crates/fj-core/src/operations/update/cycle.rs b/crates/fj-core/src/operations/update/cycle.rs
@@ -16,9 +16,9 @@ pub trait UpdateCycle {
     ///
     /// # Panics
     ///
-    /// Uses [`Handles::replace`] internally, and panics for the same reasons.
+    /// Panics, if the object can't be found.
     ///
-    /// [`Handles::replace`]: crate::objects::Handles::replace
+    /// Panics, if the update results in a duplicate object.
     #[must_use]
     fn update_half_edge(
         &self,
@@ -33,10 +33,9 @@ pub trait UpdateCycle {
     ///
     /// # Panics
     ///
-    /// Uses [`Handles::replace_with_multiple`] internally, and panics for the
-    /// same reasons.
+    /// Panics, if the object can't be found.
     ///
-    /// [`Handles::replace_with_multiple`]: crate::objects::Handles::replace_with_multiple
+    /// Panics, if the update results in a duplicate object.
     #[must_use]
     fn replace_half_edge<const N: usize>(
         &self,

diff --git a/crates/fj-core/src/operations/update/region.rs b/crates/fj-core/src/operations/update/region.rs
@@ -23,9 +23,9 @@ pub trait UpdateRegion {
     ///
     /// # Panics
     ///
-    /// Uses [`Handles::replace`] internally, and panics for the same reasons.
+    /// Panics, if the object can't be found.
     ///
-    /// [`Handles::replace`]: crate::objects::Handles::replace
+    /// Panics, if the update results in a duplicate object.
     #[must_use]
     fn update_interior(
         &self,
@@ -40,10 +40,9 @@ pub trait UpdateRegion {
     ///
     /// # Panics
     ///
-    /// Uses [`Handles::replace_with_multiple`] internally, and panics for the
-    /// same reasons.
+    /// Panics, if the object can't be found.
     ///
-    /// [`Handles::replace_with_multiple`]: crate::objects::Handles::replace_with_multiple
+    /// Panics, if the update results in a duplicate object.
     #[must_use]
     fn replace_interior<const N: usize>(
         &self,

diff --git a/crates/fj-core/src/operations/update/shell.rs b/crates/fj-core/src/operations/update/shell.rs
@@ -13,9 +13,9 @@ pub trait UpdateShell {
     ///
     /// # Panics
     ///
-    /// Uses [`Handles::replace`] internally, and panics for the same reasons.
+    /// Panics, if the object can't be found.
     ///
-    /// [`Handles::replace`]: crate::objects::Handles::replace
+    /// Panics, if the update results in a duplicate object.
     #[must_use]
     fn update_face(
         &self,
@@ -30,10 +30,9 @@ pub trait UpdateShell {
     ///
     /// # Panics
     ///
-    /// Uses [`Handles::replace_with_multiple`] internally, and panics for the
-    /// same reasons.
+    /// Panics, if the object can't be found.
     ///
-    /// [`Handles::replace_with_multiple`]: crate::objects::Handles::replace_with_multiple
+    /// Panics, if the update results in a duplicate object.
     #[must_use]
     fn replace_face<const N: usize>(
         &self,

diff --git a/crates/fj-core/src/operations/update/sketch.rs b/crates/fj-core/src/operations/update/sketch.rs
@@ -13,9 +13,9 @@ pub trait UpdateSketch {
     ///
     /// # Panics
     ///
-    /// Uses [`Handles::replace`] internally, and panics for the same reasons.
+    /// Panics, if the object can't be found.
     ///
-    /// [`Handles::replace`]: crate::objects::Handles::replace
+    /// Panics, if the update results in a duplicate object.
     #[must_use]
     fn update_region(
         &self,
@@ -30,10 +30,9 @@ pub trait UpdateSketch {
     ///
     /// # Panics
     ///
-    /// Uses [`Handles::replace_with_multiple`] internally, and panics for the
-    /// same reasons.
+    /// Panics, if the object can't be found.
     ///
-    /// [`Handles::replace_with_multiple`]: crate::objects::Handles::replace_with_multiple
+    /// Panics, if the update results in a duplicate object.
     #[must_use]
     fn replace_region<const N: usize>(
         &self,

diff --git a/crates/fj-core/src/operations/update/solid.rs b/crates/fj-core/src/operations/update/solid.rs
@@ -16,9 +16,9 @@ pub trait UpdateSolid {
     ///
     /// # Panics
     ///
-    /// Uses [`Handles::replace`] internally, and panics for the same reasons.
+    /// Panics, if the object can't be found.
     ///
-    /// [`Handles::replace`]: crate::objects::Handles::replace
+    /// Panics, if the update results in a duplicate object.
     #[must_use]
     fn update_shell(
         &self,
@@ -33,10 +33,9 @@ pub trait UpdateSolid {
     ///
     /// # Panics
     ///
-    /// Uses [`Handles::replace_with_multiple`] internally, and panics for the
-    /// same reasons.
+    /// Panics, if the object can't be found.
     ///
-    /// [`Handles::replace_with_multiple`]: crate::objects::Handles::replace_with_multiple
+    /// Panics, if the update results in a duplicate object.
     #[must_use]
     fn replace_shell<const N: usize>(
         &self,