Document Solid::sweep_from

experiments/2024-12-09/src/topology/solid.rs

@@ -17,6 +17,17 @@ impl Solid {
         }
     }
 
+    /// Sweep a face along a path, creating a solid
+    ///
+    /// ## Implementation Note
+    ///
+    /// This method has very particular (and undocumented) requirements about
+    /// the orientation of the two faces relative to each other, and will
+    /// happily generate invalid geometry, if those undocumented requirements
+    /// aren't met.
+    ///
+    /// It should be seen as more of a placeholder for a real implementation of
+    /// this operation.
     pub fn sweep_from(
         origin: Handle<Face>,
         path: impl Into<Vector<3>>,