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,16 +8,18 @@ layout: manual
Draw a line relative to the current origin to a specified distance away from the current position along the 'y' axis.
```kcl
yLine(
@sketch: Sketch,
length?: number(Length),
endAbsolute?: number(Length),
tag?: TagDecl,
): Sketch
exampleSketch = startSketchOn(XZ)
|> startProfile(at = [0, 0])
|> yLine(length = 15)
|> angledLine(angle = 30deg, length = 15)
|> line(end = [8, -10])
|> yLine(length = -5)
|> close()
example = extrude(exampleSketch, length = 10)
```
### Arguments
| Name | Type | Description | Required |
@ -32,6 +34,17 @@ yLine(
[`Sketch`](/docs/kcl-std/types/std-types-Sketch) - A sketch is a collection of paths.
### Function signature
```kcl
yLine(
@sketch: Sketch,
length?: number(Length),
endAbsolute?: number(Length),
tag?: TagDecl,
): Sketch
```
### Examples
```kcl