ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Some improvements to the boxed signatures in the docs (#6593)

Browse Source 
* Show a more reasonable name in function docs

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Fix buggy docs for union types

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Make types in the docs signatures into links

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
Nick Cameron
2025-05-01 04:03:22 +12:00
committed by GitHub
parent ccd5b0272d
commit c050739f41
128 changed files with 821 additions and 731 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/kcl/segStart.md
View File

@ -8,8 +8,8 @@ Compute the starting point of the provided line segment.
```js
segStart(tag: TagIdentifier): [number]
```kcl
segStart(tag: [TagIdentifier](/docs/kcl/types#tag-identifier)): [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number))
```
@ -17,7 +17,7 @@ segStart(tag: TagIdentifier): [number]
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| [`tag`](/docs/kcl/types/tag) | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | The line segment being queried by its tag | Yes |
| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | The line segment being queried by its tag | Yes |
### Returns
@ -26,7 +26,7 @@ segStart(tag: TagIdentifier): [number]
### Examples
```js
```kcl
w = 15
cube = startSketchOn(XY)
|> startProfile(at = [0, 0])