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,11 +8,18 @@ layout: manual
Compute the starting point of the provided line segment along the 'x' axis.
```kcl
segStartX(@tag: TaggedEdge): number(Length)
exampleSketch = startSketchOn(XZ)
|> startProfile(at = [0, 0])
|> line(end = [20, 0], tag = $thing)
|> line(end = [0, 5])
|> line(end = [20 - segStartX(thing), 0])
|> line(end = [-20, 10])
|> close()
example = extrude(exampleSketch, length = 5)
```
### Arguments
| Name | Type | Description | Required |
@ -24,6 +31,12 @@ segStartX(@tag: TaggedEdge): number(Length)
[`number(Length)`](/docs/kcl-std/types/std-types-number) - A number.
### Function signature
```kcl
segStartX(@tag: TaggedEdge): number(Length)
```
### Examples
```kcl