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,20 @@ layout: manual
Get the next adjacent edge to the edge given.
```kcl
getNextAdjacentEdge(@edge: TaggedEdge): Edge
exampleSketch = startSketchOn(XZ)
|> startProfile(at = [0, 0])
|> line(end = [10, 0])
|> angledLine(angle = 60deg, length = 10)
|> angledLine(angle = 120deg, length = 10)
|> line(end = [-10, 0])
|> angledLine(angle = 240deg, length = 10, tag = $referenceEdge)
|> close()
example = extrude(exampleSketch, length = 5)
|> fillet(radius = 3, tags = [getNextAdjacentEdge(referenceEdge)])
```
### Arguments
| Name | Type | Description | Required |
@ -24,6 +33,12 @@ getNextAdjacentEdge(@edge: TaggedEdge): Edge
[`Edge`](/docs/kcl-std/types/std-types-Edge) - An edge of a solid.
### Function signature
```kcl
getNextAdjacentEdge(@edge: TaggedEdge): Edge
```
### Examples
```kcl