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

Updates path docs for website (#4019)

Browse Source 
* fix docs paths for website

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fix docs paths for website

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
Jess Frazelle
2024-09-27 14:26:53 -07:00
committed by GitHub
parent 30bcf21912
commit 9a437ca973
58 changed files with 158 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/kcl/angleToMatchLengthX.md
View File

@ -17,9 +17,9 @@ angleToMatchLengthX(tag: TagIdentifier, to: number, sketch_group: SketchGroup) -
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | | `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
| `to` | `number` | | Yes | | `to` | `number` | | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
### Returns ### Returns

4
docs/kcl/angleToMatchLengthY.md
View File

@ -17,9 +17,9 @@ angleToMatchLengthY(tag: TagIdentifier, to: number, sketch_group: SketchGroup) -
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | | `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
| `to` | `number` | | Yes | | `to` | `number` | | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
### Returns ### Returns

8
docs/kcl/angledLine.md
View File

@ -17,13 +17,13 @@ angledLine(data: AngledLineData, sketch_group: SketchGroup, tag?: TagDeclarator)
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`AngledLineData`](kcl/types/AngledLineData) | Data to draw an angled line. | Yes | | `data` | [`AngledLineData`](/docs/kcl/types/AngledLineData) | Data to draw an angled line. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/angledLineOfXLength.md
View File

@ -17,13 +17,13 @@ angledLineOfXLength(data: AngledLineData, sketch_group: SketchGroup, tag?: TagDe
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`AngledLineData`](kcl/types/AngledLineData) | Data to draw an angled line. | Yes | | `data` | [`AngledLineData`](/docs/kcl/types/AngledLineData) | Data to draw an angled line. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/angledLineOfYLength.md
View File

@ -17,13 +17,13 @@ angledLineOfYLength(data: AngledLineData, sketch_group: SketchGroup, tag?: TagDe
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`AngledLineData`](kcl/types/AngledLineData) | Data to draw an angled line. | Yes | | `data` | [`AngledLineData`](/docs/kcl/types/AngledLineData) | Data to draw an angled line. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/angledLineThatIntersects.md
View File

@ -17,13 +17,13 @@ angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch_group: Sketc
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`AngledLineThatIntersectsData`](kcl/types/AngledLineThatIntersectsData) | Data for drawing an angled line that intersects with a given line. | Yes | | `data` | [`AngledLineThatIntersectsData`](/docs/kcl/types/AngledLineThatIntersectsData) | Data for drawing an angled line that intersects with a given line. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/angledLineToX.md
View File

@ -17,13 +17,13 @@ angledLineToX(data: AngledLineToData, sketch_group: SketchGroup, tag?: TagDeclar
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`AngledLineToData`](kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes | | `data` | [`AngledLineToData`](/docs/kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/angledLineToY.md
View File

@ -17,13 +17,13 @@ angledLineToY(data: AngledLineToData, sketch_group: SketchGroup, tag?: TagDeclar
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`AngledLineToData`](kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes | | `data` | [`AngledLineToData`](/docs/kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/arc.md
View File

@ -19,13 +19,13 @@ arc(data: ArcData, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGrou
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`ArcData`](kcl/types/ArcData) | Data to draw an arc. | Yes | | `data` | [`ArcData`](/docs/kcl/types/ArcData) | Data to draw an arc. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

6
docs/kcl/arrayReduce.md
View File

@ -17,13 +17,13 @@ arrayReduce(array: [u64], start: SketchGroup, reduce_fn: FunctionParam) -> Sketc
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `array` | [`[u64]`](kcl/types/[u64]) | | Yes | | `array` | [`[u64]`](/docs/kcl/types/[u64]) | | Yes |
| `start` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `start` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `reduce_fn` | `FunctionParam` | | Yes | | `reduce_fn` | `FunctionParam` | | Yes |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/bezierCurve.md
View File

@ -17,13 +17,13 @@ bezierCurve(data: BezierData, sketch_group: SketchGroup, tag?: TagDeclarator) ->
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`BezierData`](kcl/types/BezierData) | Data to draw a bezier curve. | Yes | | `data` | [`BezierData`](/docs/kcl/types/BezierData) | Data to draw a bezier curve. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/chamfer.md
View File

@ -17,13 +17,13 @@ chamfer(data: ChamferData, extrude_group: ExtrudeGroup, tag?: TagDeclarator) ->
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`ChamferData`](kcl/types/ChamferData) | Data for chamfers. | Yes | | `data` | [`ChamferData`](/docs/kcl/types/ChamferData) | Data for chamfers. | Yes |
| `extrude_group` | [`ExtrudeGroup`](kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | | `extrude_group` | [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces.
### Examples ### Examples

8
docs/kcl/circle.md
View File

@ -17,13 +17,13 @@ circle(data: CircleData, sketch_surface_or_group: SketchSurfaceOrGroup, tag?: Ta
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`CircleData`](kcl/types/CircleData) | Data for drawing an circle | Yes | | `data` | [`CircleData`](/docs/kcl/types/CircleData) | Data for drawing an circle | Yes |
| `sketch_surface_or_group` | [`SketchSurfaceOrGroup`](kcl/types/SketchSurfaceOrGroup) | A sketch surface or a sketch group. | Yes | | `sketch_surface_or_group` | [`SketchSurfaceOrGroup`](/docs/kcl/types/SketchSurfaceOrGroup) | A sketch surface or a sketch group. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

6
docs/kcl/close.md
View File

@ -17,12 +17,12 @@ close(sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGroup
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

4
docs/kcl/extrude.md
View File

@ -18,11 +18,11 @@ extrude(length: number, sketch_group_set: SketchGroupSet) -> ExtrudeGroupSet
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `length` | `number` | | Yes | | `length` | `number` | | Yes |
| `sketch_group_set` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | | `sketch_group_set` | [`SketchGroupSet`](/docs/kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes |
### Returns ### Returns
[`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) - A extrude group or a group of extrude groups. [`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) - A extrude group or a group of extrude groups.
### Examples ### Examples

8
docs/kcl/fillet.md
View File

@ -17,13 +17,13 @@ fillet(data: FilletData, extrude_group: ExtrudeGroup, tag?: TagDeclarator) -> Ex
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`FilletData`](kcl/types/FilletData) | Data for fillets. | Yes | | `data` | [`FilletData`](/docs/kcl/types/FilletData) | Data for fillets. | Yes |
| `extrude_group` | [`ExtrudeGroup`](kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | | `extrude_group` | [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces.
### Examples ### Examples

2
docs/kcl/getNextAdjacentEdge.md
View File

@ -17,7 +17,7 @@ getNextAdjacentEdge(tag: TagIdentifier) -> Uuid
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | | `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
### Returns ### Returns

2
docs/kcl/getOppositeEdge.md
View File

@ -17,7 +17,7 @@ getOppositeEdge(tag: TagIdentifier) -> Uuid
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | | `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
### Returns ### Returns

2
docs/kcl/getPreviousAdjacentEdge.md
View File

@ -17,7 +17,7 @@ getPreviousAdjacentEdge(tag: TagIdentifier) -> Uuid
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | | `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
### Returns ### Returns

6
docs/kcl/helix.md
View File

@ -17,12 +17,12 @@ helix(data: HelixData, extrude_group: ExtrudeGroup) -> ExtrudeGroup
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`HelixData`](kcl/types/HelixData) | Data for helices. | Yes | | `data` | [`HelixData`](/docs/kcl/types/HelixData) | Data for helices. | Yes |
| `extrude_group` | [`ExtrudeGroup`](kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | | `extrude_group` | [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes |
### Returns ### Returns
[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces.
### Examples ### Examples

6
docs/kcl/hole.md
View File

@ -17,12 +17,12 @@ hole(hole_sketch_group: SketchGroupSet, sketch_group: SketchGroup) -> SketchGrou
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `hole_sketch_group` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | | `hole_sketch_group` | [`SketchGroupSet`](/docs/kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

4
docs/kcl/hollow.md
View File

@ -18,11 +18,11 @@ hollow(thickness: number, extrude_group: ExtrudeGroup) -> ExtrudeGroup
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `thickness` | `number` | | Yes | | `thickness` | `number` | | Yes |
| `extrude_group` | [`ExtrudeGroup`](kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | | `extrude_group` | [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes |
### Returns ### Returns
[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces.
### Examples ### Examples

4
docs/kcl/import.md
View File

@ -19,11 +19,11 @@ import(file_path: String, options?: ImportFormat) -> ImportedGeometry
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `file_path` | `String` | | Yes | | `file_path` | `String` | | Yes |
| `options` | [`ImportFormat`](kcl/types/ImportFormat) | Import format specifier | No | | `options` | [`ImportFormat`](/docs/kcl/types/ImportFormat) | Import format specifier | No |
### Returns ### Returns
[`ImportedGeometry`](kcl/types/ImportedGeometry) - Data for an imported geometry. [`ImportedGeometry`](/docs/kcl/types/ImportedGeometry) - Data for an imported geometry.
### Examples ### Examples

2
docs/kcl/lastSegX.md
View File

@ -17,7 +17,7 @@ lastSegX(sketch_group: SketchGroup) -> number
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
### Returns ### Returns

2
docs/kcl/lastSegY.md
View File

@ -17,7 +17,7 @@ lastSegY(sketch_group: SketchGroup) -> number
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
### Returns ### Returns

8
docs/kcl/line.md
View File

@ -17,13 +17,13 @@ line(delta: [number], sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchG
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `delta` | [`[number]`](kcl/types/[number]) | | Yes | | `delta` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/lineTo.md
View File

@ -17,13 +17,13 @@ lineTo(to: [number], sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGr
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `to` | [`[number]`](kcl/types/[number]) | | Yes | | `to` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

6
docs/kcl/loft.md
View File

@ -17,12 +17,12 @@ loft(sketch_groups: [SketchGroup], data?: LoftData) -> ExtrudeGroup
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `sketch_groups` | [`[SketchGroup]`](kcl/types/[SketchGroup]) | | Yes | | `sketch_groups` | [`[SketchGroup]`](/docs/kcl/types/[SketchGroup]) | | Yes |
| `data` | [`LoftData`](kcl/types/LoftData) | Data for a loft. | No | | `data` | [`LoftData`](/docs/kcl/types/LoftData) | Data for a loft. | No |
### Returns ### Returns
[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces.
### Examples ### Examples

2
docs/kcl/max.md
View File

@ -21,7 +21,7 @@ max(args: [number]) -> number
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `args` | [`[number]`](kcl/types/[number]) | | Yes | | `args` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
### Returns ### Returns

2
docs/kcl/min.md
View File

@ -21,7 +21,7 @@ min(args: [number]) -> number
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `args` | [`[number]`](kcl/types/[number]) | | Yes | | `args` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
### Returns ### Returns

6
docs/kcl/mirror2d.md
View File

@ -18,12 +18,12 @@ mirror2d(data: Mirror2dData, sketch_group_set: SketchGroupSet) -> [SketchGroup]
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`Mirror2dData`](kcl/types/Mirror2dData) | Data for a mirror. | Yes | | `data` | [`Mirror2dData`](/docs/kcl/types/Mirror2dData) | Data for a mirror. | Yes |
| `sketch_group_set` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | | `sketch_group_set` | [`SketchGroupSet`](/docs/kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes |
### Returns ### Returns
[`[SketchGroup]`](kcl/types/[SketchGroup]) [`[SketchGroup]`](/docs/kcl/types/[SketchGroup])
### Examples ### Examples

4
docs/kcl/offsetPlane.md
View File

@ -17,12 +17,12 @@ offsetPlane(std_plane: StandardPlane, offset: number) -> PlaneData
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `std_plane` | [`StandardPlane`](kcl/types/StandardPlane) | One of the standard planes. | Yes | | `std_plane` | [`StandardPlane`](/docs/kcl/types/StandardPlane) | One of the standard planes. | Yes |
| `offset` | `number` | | Yes | | `offset` | `number` | | Yes |
### Returns ### Returns
[`PlaneData`](kcl/types/PlaneData) - Data for a plane. [`PlaneData`](/docs/kcl/types/PlaneData) - Data for a plane.
### Examples ### Examples

6
docs/kcl/patternCircular2d.md
View File

@ -17,12 +17,12 @@ patternCircular2d(data: CircularPattern2dData, sketch_group_set: SketchGroupSet)
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`CircularPattern2dData`](kcl/types/CircularPattern2dData) | Data for a circular pattern on a 2D sketch. | Yes | | `data` | [`CircularPattern2dData`](/docs/kcl/types/CircularPattern2dData) | Data for a circular pattern on a 2D sketch. | Yes |
| `sketch_group_set` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | | `sketch_group_set` | [`SketchGroupSet`](/docs/kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes |
### Returns ### Returns
[`[SketchGroup]`](kcl/types/[SketchGroup]) [`[SketchGroup]`](/docs/kcl/types/[SketchGroup])
### Examples ### Examples

6
docs/kcl/patternCircular3d.md
View File

@ -17,12 +17,12 @@ patternCircular3d(data: CircularPattern3dData, extrude_group_set: ExtrudeGroupSe
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`CircularPattern3dData`](kcl/types/CircularPattern3dData) | Data for a circular pattern on a 3D model. | Yes | | `data` | [`CircularPattern3dData`](/docs/kcl/types/CircularPattern3dData) | Data for a circular pattern on a 3D model. | Yes |
| `extrude_group_set` | [`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | | `extrude_group_set` | [`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes |
### Returns ### Returns
[`[ExtrudeGroup]`](kcl/types/[ExtrudeGroup]) [`[ExtrudeGroup]`](/docs/kcl/types/[ExtrudeGroup])
### Examples ### Examples

6
docs/kcl/patternLinear2d.md
View File

@ -17,12 +17,12 @@ patternLinear2d(data: LinearPattern2dData, sketch_group_set: SketchGroupSet) ->
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`LinearPattern2dData`](kcl/types/LinearPattern2dData) | Data for a linear pattern on a 2D sketch. | Yes | | `data` | [`LinearPattern2dData`](/docs/kcl/types/LinearPattern2dData) | Data for a linear pattern on a 2D sketch. | Yes |
| `sketch_group_set` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | | `sketch_group_set` | [`SketchGroupSet`](/docs/kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes |
### Returns ### Returns
[`[SketchGroup]`](kcl/types/[SketchGroup]) [`[SketchGroup]`](/docs/kcl/types/[SketchGroup])
### Examples ### Examples

6
docs/kcl/patternLinear3d.md
View File

@ -17,12 +17,12 @@ patternLinear3d(data: LinearPattern3dData, extrude_group_set: ExtrudeGroupSet) -
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`LinearPattern3dData`](kcl/types/LinearPattern3dData) | Data for a linear pattern on a 3D model. | Yes | | `data` | [`LinearPattern3dData`](/docs/kcl/types/LinearPattern3dData) | Data for a linear pattern on a 3D model. | Yes |
| `extrude_group_set` | [`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | | `extrude_group_set` | [`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes |
### Returns ### Returns
[`[ExtrudeGroup]`](kcl/types/[ExtrudeGroup]) [`[ExtrudeGroup]`](/docs/kcl/types/[ExtrudeGroup])
### Examples ### Examples

4
docs/kcl/patternTransform.md
View File

@ -21,11 +21,11 @@ patternTransform(total_instances: u32, transform_function: FunctionParam, extrud
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `total_instances` | `u32` | | Yes | | `total_instances` | `u32` | | Yes |
| `transform_function` | `FunctionParam` | | Yes | | `transform_function` | `FunctionParam` | | Yes |
| `extrude_group_set` | [`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | | `extrude_group_set` | [`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes |
### Returns ### Returns
[`[ExtrudeGroup]`](kcl/types/[ExtrudeGroup]) [`[ExtrudeGroup]`](/docs/kcl/types/[ExtrudeGroup])
### Examples ### Examples

4
docs/kcl/polar.md
View File

@ -17,11 +17,11 @@ polar(data: PolarCoordsData) -> [number]
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`PolarCoordsData`](kcl/types/PolarCoordsData) | Data for polar coordinates. | Yes | | `data` | [`PolarCoordsData`](/docs/kcl/types/PolarCoordsData) | Data for polar coordinates. | Yes |
### Returns ### Returns
[`[number]`](kcl/types/[number]) [`[number]`](/docs/kcl/types/[number])
### Examples ### Examples

4
docs/kcl/profileStart.md
View File

@ -17,11 +17,11 @@ profileStart(sketch_group: SketchGroup) -> [number]
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
### Returns ### Returns
[`[number]`](kcl/types/[number]) [`[number]`](/docs/kcl/types/[number])
### Examples ### Examples

2
docs/kcl/profileStartX.md
View File

@ -17,7 +17,7 @@ profileStartX(sketch_group: SketchGroup) -> number
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
### Returns ### Returns

2
docs/kcl/profileStartY.md
View File

@ -17,7 +17,7 @@ profileStartY(sketch_group: SketchGroup) -> number
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
### Returns ### Returns

6
docs/kcl/revolve.md
View File

@ -18,12 +18,12 @@ revolve(data: RevolveData, sketch_group: SketchGroup) -> ExtrudeGroup
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`RevolveData`](kcl/types/RevolveData) | Data for revolution surfaces. | Yes | | `data` | [`RevolveData`](/docs/kcl/types/RevolveData) | Data for revolution surfaces. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
### Returns ### Returns
[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces.
### Examples ### Examples

2
docs/kcl/segAng.md
View File

@ -17,7 +17,7 @@ segAng(tag: TagIdentifier) -> number
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | | `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
### Returns ### Returns

2
docs/kcl/segEndX.md
View File

@ -17,7 +17,7 @@ segEndX(tag: TagIdentifier) -> number
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | | `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
### Returns ### Returns

2
docs/kcl/segEndY.md
View File

@ -17,7 +17,7 @@ segEndY(tag: TagIdentifier) -> number
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | | `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
### Returns ### Returns

2
docs/kcl/segLen.md
View File

@ -17,7 +17,7 @@ segLen(tag: TagIdentifier) -> number
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | | `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
### Returns ### Returns

6
docs/kcl/shell.md
View File

@ -17,12 +17,12 @@ shell(data: ShellData, extrude_group_set: ExtrudeGroupSet) -> ExtrudeGroupSet
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`ShellData`](kcl/types/ShellData) | Data for shells. | Yes | | `data` | [`ShellData`](/docs/kcl/types/ShellData) | Data for shells. | Yes |
| `extrude_group_set` | [`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | | `extrude_group_set` | [`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes |
### Returns ### Returns
[`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) - A extrude group or a group of extrude groups. [`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) - A extrude group or a group of extrude groups.
### Examples ### Examples

8
docs/kcl/startProfileAt.md
View File

@ -17,13 +17,13 @@ startProfileAt(to: [number], sketch_surface: SketchSurface, tag?: TagDeclarator)
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `to` | [`[number]`](kcl/types/[number]) | | Yes | | `to` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `sketch_surface` | [`SketchSurface`](kcl/types/SketchSurface) | A sketch group type. | Yes | | `sketch_surface` | [`SketchSurface`](/docs/kcl/types/SketchSurface) | A sketch group type. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

4
docs/kcl/startSketchAt.md
View File

@ -17,11 +17,11 @@ startSketchAt(data: [number]) -> SketchGroup
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`[number]`](kcl/types/[number]) | | Yes | | `data` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

6
docs/kcl/startSketchOn.md
View File

@ -17,12 +17,12 @@ startSketchOn(data: SketchData, tag?: FaceTag) -> SketchSurface
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`SketchData`](kcl/types/SketchData) | Data for start sketch on. You can start a sketch on a plane or an extrude group. | Yes | | `data` | [`SketchData`](/docs/kcl/types/SketchData) | Data for start sketch on. You can start a sketch on a plane or an extrude group. | Yes |
| `tag` | [`FaceTag`](kcl/types/FaceTag) | A tag for a face. | No | | `tag` | [`FaceTag`](/docs/kcl/types/FaceTag) | A tag for a face. | No |
### Returns ### Returns
[`SketchSurface`](kcl/types/SketchSurface) - A sketch group type. [`SketchSurface`](/docs/kcl/types/SketchSurface) - A sketch group type.
### Examples ### Examples

8
docs/kcl/tangentialArc.md
View File

@ -18,13 +18,13 @@ tangentialArc(data: TangentialArcData, sketch_group: SketchGroup, tag?: TagDecla
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `data` | [`TangentialArcData`](kcl/types/TangentialArcData) | Data to draw a tangential arc. | Yes | | `data` | [`TangentialArcData`](/docs/kcl/types/TangentialArcData) | Data to draw a tangential arc. | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/tangentialArcTo.md
View File

@ -17,13 +17,13 @@ tangentialArcTo(to: [number], sketch_group: SketchGroup, tag?: TagDeclarator) ->
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `to` | [`[number]`](kcl/types/[number]) | | Yes | | `to` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

8
docs/kcl/tangentialArcToRelative.md
View File

@ -17,13 +17,13 @@ tangentialArcToRelative(delta: [number], sketch_group: SketchGroup, tag?: TagDec
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `delta` | [`[number]`](kcl/types/[number]) | | Yes | | `delta` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

6
docs/kcl/xLine.md
View File

@ -18,12 +18,12 @@ xLine(length: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchG
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `length` | `number` | | Yes | | `length` | `number` | | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

6
docs/kcl/xLineTo.md
View File

@ -18,12 +18,12 @@ xLineTo(to: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGro
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `to` | `number` | | Yes | | `to` | `number` | | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

6
docs/kcl/yLine.md
View File

@ -18,12 +18,12 @@ yLine(length: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchG
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `length` | `number` | | Yes | | `length` | `number` | | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

6
docs/kcl/yLineTo.md
View File

@ -18,12 +18,12 @@ yLineTo(to: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGro
| Name | Type | Description | Required | | Name | Type | Description | Required |
|----------|------|-------------|----------| |----------|------|-------------|----------|
| `to` | `number` | | Yes | | `to` | `number` | | Yes |
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
### Returns ### Returns
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. [`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths.
### Examples ### Examples

12
src/wasm-lib/kcl/src/docs/gen_std_tests.rs
View File

@ -152,7 +152,7 @@ fn generate_index(combined: &HashMap<String, Box<dyn StdLibFn>>) -> Result<()> {
let output = hbs.render("index", &data)?; let output = hbs.render("index", &data)?;
std::fs::write("../../../docs/kcl/index.md", output)?; expectorate::assert_contents("../../../docs/kcl/index.md", &output);
Ok(()) Ok(())
} }
@ -245,18 +245,18 @@ fn generate_function(internal_fn: Box<dyn StdLibFn>) -> Result<()> {
for type_name in types { for type_name in types {
let formatted_type_name = format!("`{}`", type_name); let formatted_type_name = format!("`{}`", type_name);
if type_name == "TagDeclarator" { if type_name == "TagDeclarator" {
let link = format!("[`{}`](kcl/types#tag-declaration)", "TagDeclarator"); let link = format!("[`{}`](/docs/kcl/types#tag-declaration)", "TagDeclarator");
output = output.replace(&formatted_type_name, &link); output = output.replace(&formatted_type_name, &link);
} else if type_name == "TagIdentifier" { } else if type_name == "TagIdentifier" {
let link = format!("[`{}`](kcl/types#tag-identifier)", "TagIdentifier"); let link = format!("[`{}`](/docs/kcl/types#tag-identifier)", "TagIdentifier");
output = output.replace(&formatted_type_name, &link); output = output.replace(&formatted_type_name, &link);
} else { } else {
let link = format!("[`{}`](kcl/types/{})", type_name, type_name); let link = format!("[`{}`](/docs/kcl/types/{})", type_name, type_name);
output = output.replace(&formatted_type_name, &link); output = output.replace(&formatted_type_name, &link);
} }
} }
std::fs::write(format!("../../../docs/kcl/{}.md", fn_name), output)?; expectorate::assert_contents(format!("../../../docs/kcl/{}.md", fn_name), &output);
Ok(()) Ok(())
} }
@ -334,7 +334,7 @@ fn generate_type(name: &str, schema: &schemars::schema::Schema) -> Result<()> {
let data = json!(schemars::schema::Schema::Object(object)); let data = json!(schemars::schema::Schema::Object(object));
let output = hbs.render("type", &data)?; let output = hbs.render("type", &data)?;
std::fs::write(format!("{}/{}.md", TYPES_DIR, name), output)?; expectorate::assert_contents(format!("{}/{}.md", TYPES_DIR, name), &output);
Ok(()) Ok(())
} }