Update example code

KittyCAD · Dec 17, 2024 · 356b257 · 356b257
1 parent 5f6057f
commit 356b257
Show file tree

Hide file tree

Showing 123 changed files with 1,539 additions and 1,377 deletions.
diff --git a/docs/kcl/abs.md b/docs/kcl/abs.md
diff --git a/docs/kcl/acos.md b/docs/kcl/acos.md
diff --git a/docs/kcl/angleToMatchLengthX.md b/docs/kcl/angleToMatchLengthX.md
diff --git a/docs/kcl/angleToMatchLengthY.md b/docs/kcl/angleToMatchLengthY.md
diff --git a/docs/kcl/angledLine.md b/docs/kcl/angledLine.md
diff --git a/docs/kcl/angledLineOfXLength.md b/docs/kcl/angledLineOfXLength.md
diff --git a/docs/kcl/angledLineOfYLength.md b/docs/kcl/angledLineOfYLength.md
diff --git a/docs/kcl/angledLineThatIntersects.md b/docs/kcl/angledLineThatIntersects.md
diff --git a/docs/kcl/angledLineToX.md b/docs/kcl/angledLineToX.md
diff --git a/docs/kcl/angledLineToY.md b/docs/kcl/angledLineToY.md
diff --git a/docs/kcl/appearance.md b/docs/kcl/appearance.md
@@ -31,12 +31,12 @@ appearance(data: AppearanceData, solid_set: SolidSet) -> SolidSet
 // Add color to an extruded solid.
 exampleSketch = startSketchOn("XZ")
   |> startProfileAt([0, 0], %)
-  |> lineTo([10, 0], %)
-  |> lineTo([0, 10], %)
-  |> lineTo([-10, 0], %)
-  |> close(%)
+  |> line(end = [10, 0])
+  |> line(end = [0, 10])
+  |> line(end = [-10, 0])
+  |> close()
 
-example = extrude(5, exampleSketch)
+example = extrude(exampleSketch, length = 5)
   |> appearance({
        color = '#ff0000',
        metalness = 50,
@@ -65,11 +65,11 @@ sketch001 = startSketchOn('XY')
 fn cube(center) {
   return startSketchOn('XY')
     |> startProfileAt([center[0] - 10, center[1] - 10], %)
-    |> lineTo([center[0] + 10, center[1] - 10], %)
-    |> lineTo([center[0] + 10, center[1] + 10], %)
-    |> lineTo([center[0] - 10, center[1] + 10], %)
-    |> close(%)
-    |> extrude(10, %)
+    |> line(end = [center[0] + 10, center[1] - 10])
+    |> line(end = [center[0] + 10, center[1] + 10])
+    |> line(end = [center[0] - 10, center[1] + 10])
+    |> close()
+    |> extrude(length = 10)
 }
 
 example0 = cube([0, 0])
@@ -95,11 +95,11 @@ appearance({
 // This example shows setting the appearance _after_ the shell.
 firstSketch = startSketchOn('XY')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
-  |> line([0, -24], %)
-  |> line([-24, 0], %)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(to = [24, 0])
+  |> line(to = [0, -24])
+  |> line(to = [-24, 0])
+  |> close()
+  |> extrude(length = 6)
 
 shell({ faces = ['end'], thickness = 0.25 }, firstSketch)
   |> appearance({
@@ -116,11 +116,11 @@ shell({ faces = ['end'], thickness = 0.25 }, firstSketch)
 // This example shows setting the appearance _before_ the shell.
 firstSketch = startSketchOn('XY')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
-  |> line([0, -24], %)
-  |> line([-24, 0], %)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(to = [24, 0])
+  |> line(to = [0, -24])
+  |> line(to = [-24, 0])
+  |> close()
+  |> extrude(length = 6)
   |> appearance({
        color = '#ff0000',
        metalness = 90,
@@ -137,12 +137,12 @@ shell({ faces = ['end'], thickness = 0.25 }, firstSketch)
 // This example shows _before_ the pattern.
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([0, 2], %)
-  |> line([3, 1], %)
-  |> line([0, -4], %)
-  |> close(%)
+  |> line(to = [0, 2])
+  |> line(to = [3, 1])
+  |> line(to = [0, -4])
+  |> close()
 
-example = extrude(1, exampleSketch)
+example = extrude(exampleSketch, length = 1)
   |> appearance({
        color = '#ff0000',
        metalness = 90,
@@ -162,12 +162,12 @@ example = extrude(1, exampleSketch)
 // This example shows _after_ the pattern.
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([0, 2], %)
-  |> line([3, 1], %)
-  |> line([0, -4], %)
-  |> close(%)
+  |> line(to = [0, 2])
+  |> line(to = [3, 1])
+  |> line(to = [0, -4])
+  |> close()
 
-example = extrude(1, exampleSketch)
+example = extrude(exampleSketch, length = 1)
   |> patternLinear3d({
        axis = [1, 0, 1],
        instances = 7,
@@ -186,18 +186,18 @@ example = extrude(1, exampleSketch)
 // Color the result of a 2D pattern that was extruded.
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([.5, 25], %)
-  |> line([0, 5], %)
-  |> line([-1, 0], %)
-  |> line([0, -5], %)
-  |> close(%)
+  |> line(to = [0, 5])
+  |> line(to = [-1, 0])
+  |> line(to = [0, -5])
+  |> close()
   |> patternCircular2d({
        center = [0, 0],
        instances = 13,
        arcDegrees = 360,
        rotateDuplicates = true
      }, %)
 
-example = extrude(1, exampleSketch)
+example = extrude(exampleSketch, length = 1)
   |> appearance({
        color = '#ff0000',
        metalness = 90,
@@ -214,11 +214,11 @@ example = extrude(1, exampleSketch)
 // Create a path for the sweep.
 sweepPath = startSketchOn('XZ')
   |> startProfileAt([0.05, 0.05], %)
-  |> line([0, 7], %)
+  |> line(to = [0, 7])
   |> tangentialArc({ offset = 90, radius = 5 }, %)
-  |> line([-3, 0], %)
+  |> line(to = [-3, 0])
   |> tangentialArc({ offset = -90, radius = 5 }, %)
-  |> line([0, 7], %)
+  |> line(to = [0, 7])
 
 pipeHole = startSketchOn('XY')
   |> circle({ center = [0, 0], radius = 1.5 }, %)

diff --git a/docs/kcl/arc.md b/docs/kcl/arc.md
diff --git a/docs/kcl/arcTo.md b/docs/kcl/arcTo.md
diff --git a/docs/kcl/asin.md b/docs/kcl/asin.md
diff --git a/docs/kcl/atan.md b/docs/kcl/atan.md
diff --git a/docs/kcl/atan2.md b/docs/kcl/atan2.md
diff --git a/docs/kcl/bezierCurve.md b/docs/kcl/bezierCurve.md
diff --git a/docs/kcl/ceil.md b/docs/kcl/ceil.md
diff --git a/docs/kcl/chamfer.md b/docs/kcl/chamfer.md
diff --git a/docs/kcl/circle.md b/docs/kcl/circle.md
diff --git a/docs/kcl/close.md b/docs/kcl/close.md
diff --git a/docs/kcl/cos.md b/docs/kcl/cos.md
diff --git a/docs/kcl/e.md b/docs/kcl/e.md
diff --git a/docs/kcl/extrude.md b/docs/kcl/extrude.md
diff --git a/docs/kcl/fillet.md b/docs/kcl/fillet.md
@@ -36,12 +36,12 @@ filletRadius = 2
 
 mountingPlateSketch = startSketchOn("XY")
   |> startProfileAt([-width / 2, -length / 2], %)
-  |> lineTo([width / 2, -length / 2], %, $edge1)
-  |> lineTo([width / 2, length / 2], %, $edge2)
-  |> lineTo([-width / 2, length / 2], %, $edge3)
-  |> close(%, $edge4)
+  |> line(end = [width / 2, -length / 2], tag = $edge1)
+  |> line(end = [width / 2, length / 2], tag = $edge2)
+  |> line(end = [-width / 2, length / 2], tag = $edge3)
+  |> close(tag = $edge4)
 
-mountingPlate = extrude(thickness, mountingPlateSketch)
+mountingPlate = extrude(mountingPlateSketch, length = thickness)
   |> fillet({
        radius = filletRadius,
        tags = [
@@ -63,12 +63,12 @@ filletRadius = 1
 
 mountingPlateSketch = startSketchOn("XY")
   |> startProfileAt([-width / 2, -length / 2], %)
-  |> lineTo([width / 2, -length / 2], %, $edge1)
-  |> lineTo([width / 2, length / 2], %, $edge2)
-  |> lineTo([-width / 2, length / 2], %, $edge3)
-  |> close(%, $edge4)
+  |> line(end = [width / 2, -length / 2], tag = $edge1)
+  |> line(end = [width / 2, length / 2], tag = $edge2)
+  |> line(end = [-width / 2, length / 2], tag = $edge3)
+  |> close(tag = $edge4)
 
-mountingPlate = extrude(thickness, mountingPlateSketch)
+mountingPlate = extrude(mountingPlateSketch, length = thickness)
   |> fillet({
        radius = filletRadius,
        tolerance = 0.000001,

diff --git a/docs/kcl/floor.md b/docs/kcl/floor.md
diff --git a/docs/kcl/getNextAdjacentEdge.md b/docs/kcl/getNextAdjacentEdge.md
@@ -29,14 +29,14 @@ getNextAdjacentEdge(tag: TagIdentifier) -> Uuid
 ```js
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([10, 0], %)
+  |> line(to = [10, 0])
   |> angledLine({ angle = 60, length = 10 }, %)
   |> angledLine({ angle = 120, length = 10 }, %)
-  |> line([-10, 0], %)
+  |> line(to = [-10, 0])
   |> angledLine({ angle = 240, length = 10 }, %, $referenceEdge)
-  |> close(%)
+  |> close()
 
-example = extrude(5, exampleSketch)
+example = extrude(exampleSketch, length = 5)
   |> fillet({
        radius = 3,
        tags = [getNextAdjacentEdge(referenceEdge)]

diff --git a/docs/kcl/getOppositeEdge.md b/docs/kcl/getOppositeEdge.md
@@ -29,14 +29,14 @@ getOppositeEdge(tag: TagIdentifier) -> Uuid
 ```js
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([10, 0], %)
+  |> line(to = [10, 0])
   |> angledLine({ angle = 60, length = 10 }, %)
   |> angledLine({ angle = 120, length = 10 }, %)
-  |> line([-10, 0], %)
+  |> line(to = [-10, 0])
   |> angledLine({ angle = 240, length = 10 }, %, $referenceEdge)
-  |> close(%)
+  |> close()
 
-example = extrude(5, exampleSketch)
+example = extrude(exampleSketch, length = 5)
   |> fillet({
        radius = 3,
        tags = [getOppositeEdge(referenceEdge)]

diff --git a/docs/kcl/getPreviousAdjacentEdge.md b/docs/kcl/getPreviousAdjacentEdge.md
@@ -29,14 +29,14 @@ getPreviousAdjacentEdge(tag: TagIdentifier) -> Uuid
 ```js
 exampleSketch = startSketchOn('XZ')
   |> startProfileAt([0, 0], %)
-  |> line([10, 0], %)
+  |> line(to = [10, 0])
   |> angledLine({ angle = 60, length = 10 }, %)
   |> angledLine({ angle = 120, length = 10 }, %)
-  |> line([-10, 0], %)
+  |> line(to = [-10, 0])
   |> angledLine({ angle = 240, length = 10 }, %, $referenceEdge)
-  |> close(%)
+  |> close()
 
-example = extrude(5, exampleSketch)
+example = extrude(exampleSketch, length = 5)
   |> fillet({
        radius = 3,
        tags = [getPreviousAdjacentEdge(referenceEdge)]

diff --git a/docs/kcl/helix.md b/docs/kcl/helix.md
@@ -30,7 +30,7 @@ helix(data: HelixData, solid: Solid) -> Solid
 ```js
 part001 = startSketchOn('XY')
   |> circle({ center = [5, 5], radius = 10 }, %)
-  |> extrude(10, %)
+  |> extrude(length = 10)
   |> helix({
        angleStart = 0,
        ccw = true,

diff --git a/docs/kcl/hole.md b/docs/kcl/hole.md
diff --git a/docs/kcl/hollow.md b/docs/kcl/hollow.md
@@ -31,11 +31,11 @@ hollow(thickness: number, solid: Solid) -> Solid
 // Hollow a basic sketch.
 firstSketch = startSketchOn('XY')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
-  |> line([0, -24], %)
-  |> line([-24, 0], %)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(to = [24, 0])
+  |> line(to = [0, -24])
+  |> line(to = [-24, 0])
+  |> close()
+  |> extrude(length = 6)
   |> hollow(0.25, %)
 ```
 
@@ -45,11 +45,11 @@ firstSketch = startSketchOn('XY')
 // Hollow a basic sketch.
 firstSketch = startSketchOn('-XZ')
   |> startProfileAt([-12, 12], %)
-  |> line([24, 0], %)
-  |> line([0, -24], %)
-  |> line([-24, 0], %)
-  |> close(%)
-  |> extrude(6, %)
+  |> line(to = [24, 0])
+  |> line(to = [0, -24])
+  |> line(to = [-24, 0])
+  |> close()
+  |> extrude(length = 6)
   |> hollow(0.5, %)
 ```
 
@@ -60,25 +60,25 @@ firstSketch = startSketchOn('-XZ')
 size = 100
 case = startSketchOn('-XZ')
   |> startProfileAt([-size, -size], %)
-  |> line([2 * size, 0], %)
-  |> line([0, 2 * size], %)
+  |> line(to = [2 * size, 0])
+  |> line(to = [0, 2 * size])
   |> tangentialArcTo([-size, size], %)
-  |> close(%)
-  |> extrude(65, %)
+  |> close()
+  |> extrude(length = 65)
 
 thing1 = startSketchOn(case, 'end')
   |> circle({
        center = [-size / 2, -size / 2],
        radius = 25
      }, %)
-  |> extrude(50, %)
+  |> extrude(length = 50)
 
 thing2 = startSketchOn(case, 'end')
   |> circle({
        center = [size / 2, -size / 2],
        radius = 25
      }, %)
-  |> extrude(50, %)
+  |> extrude(length = 50)
 
 hollow(0.5, case)
 ```

diff --git a/docs/kcl/int.md b/docs/kcl/int.md
@@ -36,7 +36,7 @@ assertEqual(n, 3, 0.0001, "5/2 = 2.5, rounded up makes 3")
 // Draw n cylinders.
 startSketchOn('XZ')
   |> circle({ center = [0, 0], radius = 2 }, %)
-  |> extrude(5, %)
+  |> extrude(length = 5)
   |> patternTransform(n, fn(id) {
     return { translate = [4 * id, 0, 0] }
   }, %)

diff --git a/docs/kcl/lastSegX.md b/docs/kcl/lastSegX.md
diff --git a/docs/kcl/lastSegY.md b/docs/kcl/lastSegY.md
diff --git a/docs/kcl/line.md b/docs/kcl/line.md
diff --git a/docs/kcl/ln.md b/docs/kcl/ln.md
diff --git a/docs/kcl/loft.md b/docs/kcl/loft.md
@@ -34,18 +34,18 @@ loft(sketches: [Sketch], v_degree: NonZeroU32, bez_approximate_rational: bool, b
 // Loft a square and a triangle.
 squareSketch = startSketchOn('XY')
   |> startProfileAt([-100, 200], %)
-  |> line([200, 0], %)
-  |> line([0, -200], %)
-  |> line([-200, 0], %)
-  |> lineTo([profileStartX(%), profileStartY(%)], %)
-  |> close(%)
+  |> line(to = [200, 0])
+  |> line(to = [0, -200])
+  |> line(to = [-200, 0])
+  |> line(end = [profileStartX(%), profileStartY(%)])
+  |> close()
 
 triangleSketch = startSketchOn(offsetPlane('XY', 75))
   |> startProfileAt([0, 125], %)
-  |> line([-15, -30], %)
-  |> line([30, 0], %)
-  |> lineTo([profileStartX(%), profileStartY(%)], %)
-  |> close(%)
+  |> line(to = [-15, -30])
+  |> line(to = [30, 0])
+  |> line(end = [profileStartX(%), profileStartY(%)])
+  |> close()
 
 loft([squareSketch, triangleSketch])
 ```
@@ -56,11 +56,11 @@ loft([squareSketch, triangleSketch])
 // Loft a square, a circle, and another circle.
 squareSketch = startSketchOn('XY')
   |> startProfileAt([-100, 200], %)
-  |> line([200, 0], %)
-  |> line([0, -200], %)
-  |> line([-200, 0], %)
-  |> lineTo([profileStartX(%), profileStartY(%)], %)
-  |> close(%)
+  |> line(to = [200, 0])
+  |> line(to = [0, -200])
+  |> line(to = [-200, 0])
+  |> line(end = [profileStartX(%), profileStartY(%)])
+  |> close()
 
 circleSketch0 = startSketchOn(offsetPlane('XY', 75))
   |> circle({ center = [0, 100], radius = 50 }, %)
@@ -81,11 +81,11 @@ loft([
 // Loft a square, a circle, and another circle with options.
 squareSketch = startSketchOn('XY')
   |> startProfileAt([-100, 200], %)
-  |> line([200, 0], %)
-  |> line([0, -200], %)
-  |> line([-200, 0], %)
-  |> lineTo([profileStartX(%), profileStartY(%)], %)
-  |> close(%)
+  |> line(to = [200, 0])
+  |> line(to = [0, -200])
+  |> line(to = [-200, 0])
+  |> line(end = [profileStartX(%), profileStartY(%)])
+  |> close()
 
 circleSketch0 = startSketchOn(offsetPlane('XY', 75))
   |> circle({ center = [0, 100], radius = 50 }, %)

diff --git a/docs/kcl/log.md b/docs/kcl/log.md
diff --git a/docs/kcl/log10.md b/docs/kcl/log10.md
diff --git a/docs/kcl/log2.md b/docs/kcl/log2.md
diff --git a/docs/kcl/max.md b/docs/kcl/max.md
diff --git a/docs/kcl/min.md b/docs/kcl/min.md