Make the function signature less prominent, add an early example to docs

Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
Nick Cameron
2025-06-19 17:08:46 +12:00
parent 6358eed7e4
commit ff1be99351
99 changed files with 2137 additions and 686 deletions

View File

@ -8,13 +8,22 @@ layout: manual
Mirror a sketch.
```kcl
mirror2d(
@sketches: [Sketch; 1+],
axis: Axis2d | Edge,
): Sketch
```
// Mirror an un-closed sketch across the Y axis.
sketch001 = startSketchOn(XZ)
|> startProfile(at = [0, 10])
|> line(end = [15, 0])
|> line(end = [-7, -3])
|> line(end = [9, -1])
|> line(end = [-8, -5])
|> line(end = [9, -3])
|> line(end = [-8, -3])
|> line(end = [9, -1])
|> line(end = [-19, -0])
|> mirror2d(axis = Y)
Mirror occurs around a local sketch axis rather than a global axis.
example = extrude(sketch001, length = 10)
```
### Arguments
@ -27,6 +36,18 @@ Mirror occurs around a local sketch axis rather than a global axis.
[`Sketch`](/docs/kcl-std/types/std-types-Sketch) - A sketch is a collection of paths.
### Description
Mirror occurs around a local sketch axis rather than a global axis.
### Function signature
```kcl
mirror2d(
@sketches: [Sketch; 1+],
axis: Axis2d | Edge,
): Sketch
```
### Examples