Skip to content

Commit 58b0c13

Browse files
committed
Update generated docs
1 parent 1f0587b commit 58b0c13

15 files changed

+97
-85
lines changed

docs/kcl-std/functions/std-sketch-angledLine.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ angledLine(
4444

4545
```kcl
4646
exampleSketch = startSketchOn(XZ)
47-
|> startProfile(at = [0, 0])
47+
exampleProfile = startProfile(exampleSketch, at = [0, 0])
4848
|> yLine(endAbsolute = 15)
4949
|> angledLine(angle = 30deg, length = 15)
5050
|> line(end = [8, -10])
5151
|> yLine(endAbsolute = 0)
5252
|> close()
5353
54-
example = extrude(exampleSketch, length = 10)
54+
example = extrude(exampleProfile, length = 10)
5555
5656
```
5757

docs/kcl-std/functions/std-sketch-angledLineThatIntersects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ angledLineThatIntersects(
3838

3939
```kcl
4040
exampleSketch = startSketchOn(XZ)
41-
|> startProfile(at = [0, 0])
41+
exampleProfile = startProfile(exampleSketch, at = [0, 0])
4242
|> line(endAbsolute = [5, 10])
4343
|> line(endAbsolute = [-10, 10], tag = $lineToIntersect)
4444
|> line(endAbsolute = [0, 20])
4545
|> angledLineThatIntersects(angle = 80deg, intersectTag = lineToIntersect, offset = 10)
4646
|> close()
4747
48-
example = extrude(exampleSketch, length = 10)
48+
example = extrude(exampleProfile, length = 10)
4949
5050
```
5151

docs/kcl-std/functions/std-sketch-arc.md

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

docs/kcl-std/functions/std-sketch-circle.md

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

docs/kcl-std/functions/std-sketch-close.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ startSketchOn(XZ)
4747

4848
```kcl
4949
exampleSketch = startSketchOn(-XZ)
50-
|> startProfile(at = [0, 0])
50+
exampleProfile = startProfile(exampleSketch, at = [0, 0])
5151
|> line(end = [10, 0])
5252
|> line(end = [0, 10])
5353
|> close()
5454
55-
example = extrude(exampleSketch, length = 10)
55+
example = extrude(exampleProfile, length = 10)
5656
5757
```
5858

docs/kcl-std/functions/std-sketch-ellipse.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,12 @@ ellipse(
3838

3939
```kcl
4040
exampleSketch = startSketchOn(XY)
41-
|> ellipse(center = [0, 0], majorRadius = 50, minorRadius = 20)
41+
exampleProfile = ellipse(
42+
exampleSketch,
43+
center = [0, 0],
44+
majorRadius = 50,
45+
minorRadius = 20,
46+
)
4247
4348
```
4449

docs/kcl-std/functions/std-sketch-extrude.md

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

docs/kcl-std/functions/std-sketch-line.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ line(
3535
### Examples
3636

3737
```kcl
38-
triangle = startSketchOn(XZ)
39-
|> startProfile(at = [0, 0])
38+
triangleSketch = startSketchOn(XZ)
39+
triangle = startProfile(triangleSketch, at = [0, 0])
4040
// The END argument means it ends at exactly [10, 0].
4141
// This is an absolute measurement, it is NOT relative to
4242
// the start of the sketch.
@@ -46,8 +46,8 @@ triangle = startSketchOn(XZ)
4646
|> close()
4747
|> extrude(length = 5)
4848
49-
box = startSketchOn(XZ)
50-
|> startProfile(at = [10, 10])
49+
boxSketch = startSketchOn(XZ)
50+
box = startProfile(boxSketch, at = [10, 10])
5151
// The 'to' argument means move the pen this much.
5252
// So, [10, 0] is a relative distance away from the current point.
5353
|> line(end = [10, 0])

docs/kcl-std/functions/std-sketch-planeOf.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,13 @@ planeOf(
3131
### Examples
3232

3333
```kcl
34-
triangle = startSketchOn(XY)
35-
|> polygon(radius = 3, numSides = 3, center = [0, 0])
34+
triangleSketch = startSketchOn(XY)
35+
triangle = polygon(
36+
triangleSketch,
37+
radius = 3,
38+
numSides = 3,
39+
center = [0, 0],
40+
)
3641
|> extrude(length = 2)
3742
3843
// Find the plane of the triangle's top face.

docs/kcl-std/functions/std-sketch-rectangle.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,13 @@ A rectangle can be defined by its width, height, and location. Either the center
3838

3939
```kcl
4040
exampleSketch = startSketchOn(-XZ)
41-
|> rectangle(center = [0, 0], width = 10, height = 5)
41+
rectSolid = rectangle(
42+
exampleSketch,
43+
center = [0, 0],
44+
width = 10,
45+
height = 5,
46+
)
47+
|> extrude(length = 2)
4248
4349
```
4450

0 commit comments

Comments
 (0)