From 85fe6e959c59a6cf4852c6d7cf91a15ce06dd197 Mon Sep 17 00:00:00 2001
From: Hanno Braun <hello@hannobraun.com>
Date: Fri, 31 Jan 2025 20:49:09 +0100
Subject: [PATCH] Document `Solid::sweep_from`

---
 experiments/2024-12-09/src/topology/solid.rs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/experiments/2024-12-09/src/topology/solid.rs b/experiments/2024-12-09/src/topology/solid.rs
index c3be4e8a6..408ea5e24 100644
--- a/experiments/2024-12-09/src/topology/solid.rs
+++ b/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>>,