Update doc comment of operations::sweep

hannobraun · Nov 23, 2023 · 282a2df · 282a2df
1 parent d923ec8
commit 282a2df
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/crates/fj-core/src/operations/sweep/mod.rs b/crates/fj-core/src/operations/sweep/mod.rs
@@ -1,4 +1,7 @@
-//! Sweeping objects along a path to create new objects
+//! Sweep objects along a path to create new objects
+//!
+//! Sweeps 1D or 2D objects along a straight path, creating a 2D or 3D object,
+//! respectively.
 
 mod face;
 mod half_edge;