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,17 +8,18 @@ layout: manual
Draw an angled line from the current origin, constructing a line segment such that the newly created line intersects the desired target line segment.
```kcl
angledLineThatIntersects(
@sketch: Sketch,
angle: number(Angle),
intersectTag: TaggedEdge,
offset?: number(Length),
tag?: TagDecl,
): Sketch
exampleSketch = startSketchOn(XZ)
|> startProfile(at = [0, 0])
|> line(endAbsolute = [5, 10])
|> line(endAbsolute = [-10, 10], tag = $lineToIntersect)
|> line(endAbsolute = [0, 20])
|> angledLineThatIntersects(angle = 80deg, intersectTag = lineToIntersect, offset = 10)
|> close()
example = extrude(exampleSketch, length = 10)
```
### Arguments
| Name | Type | Description | Required |
@ -34,6 +35,18 @@ angledLineThatIntersects(
[`Sketch`](/docs/kcl-std/types/std-types-Sketch) - A sketch is a collection of paths.
### Function signature
```kcl
angledLineThatIntersects(
@sketch: Sketch,
angle: number(Angle),
intersectTag: TaggedEdge,
offset?: number(Length),
tag?: TagDecl,
): Sketch
```
### Examples
```kcl