toolbox-inserts: WellSurround: better docs, screws (nyi)

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

diff --git a/toolbox-inserts.scad b/toolbox-inserts.scad
index f275da6441bfd308e11e95edcc3d03fc32ec46c1..b3fde408ed9aed489401b97bad4295df886f5397 100644 (file)
--- a/toolbox-inserts.scad
+++ b/toolbox-inserts.scad
@@ -38,23 +38,24 @@ module WallMinkowskiSphere(wall=well_surround_wall) { ////toplevel
   sphere($fn=8, r=wall/2);
 }
 
+// WellSurround(...) {
+//     SomethingPositive();
+// }
+//
+// SomethingPositive must extend in z
+//     from -half_height to at least 0, and probably to half_height
+// IOW its z==0 must be where the top of the wall is,
+// and half_height is the depth of the well below that.
 module WellSurround(
   half_height,
+  // gaps for picking up object, [ [ x_min, x_max ], ... ]
   gaps,
+  // screw locations in stride units, [ [screw_xu, screw_yu], ... ]
+  screws,
+  // offset=[x,y] moves the whole thing by that amount, but not the screws
   offset,
   wall=well_surround_wall
 ) {
-  // WellSurround(half_height, gaps[
-  //    [ x_min, x_max ],
-  //    ...
-  // ]) {
-  //     SomethingPositive();
-  // }
-  //
-  // SomethingPositive must extend in z
-  //     from -half_height to at least 0, and probably to half_height
-  // IOW its z==0 must be where the top of the wall is,
-  // and half_height is the depth of the well below that.
 
   render() difference(){
 //    minkowski(){