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,15 +8,17 @@ layout: manual
Start a new profile at a given point.
```kcl
startProfile(
@startProfileOn: Plane | Face,
at: Point2d,
tag?: TagDecl,
): Sketch
exampleSketch = startSketchOn(XZ)
|> startProfile(at = [0, 0])
|> line(end = [10, 0])
|> line(end = [0, 10])
|> line(end = [-10, 0])
|> close()
example = extrude(exampleSketch, length = 5)
```
### Arguments
| Name | Type | Description | Required |
@ -30,6 +32,16 @@ startProfile(
[`Sketch`](/docs/kcl-std/types/std-types-Sketch) - A sketch is a collection of paths.
### Function signature
```kcl
startProfile(
@startProfileOn: Plane | Face,
at: Point2d,
tag?: TagDecl,
): Sketch
```
### Examples
```kcl