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,30 @@ layout: manual
Compute the starting point of the provided line segment.
```kcl
segStart(@tag: TaggedEdge): Point2d
w = 15
cube = startSketchOn(XY)
|> startProfile(at = [0, 0])
|> line(end = [w, 0], tag = $line1)
|> line(end = [0, w], tag = $line2)
|> line(end = [-w, 0], tag = $line3)
|> line(end = [0, -w], tag = $line4)
|> close()
|> extrude(length = 5)
fn cylinder(radius, tag) {
return startSketchOn(XY)
|> startProfile(at = [0, 0])
|> circle(radius = radius, center = segStart(tag))
|> extrude(length = radius)
}
cylinder(radius = 1, tag = line1)
cylinder(radius = 2, tag = line2)
cylinder(radius = 3, tag = line3)
cylinder(radius = 4, tag = line4)
```
### Arguments
| Name | Type | Description | Required |
@ -24,6 +43,12 @@ segStart(@tag: TaggedEdge): Point2d
[`Point2d`](/docs/kcl-std/types/std-types-Point2d) - A point in two dimensional space.
### Function signature
```kcl
segStart(@tag: TaggedEdge): Point2d
```
### Examples
```kcl