Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix links for kcl docs #1714

Merged
merged 4 commits into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/kcl/abs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Computes the absolute value of a number.



```
```js
abs(num: number) -> number
```

### Examples

```kcl
```js
const myVar = abs(-4)
```

Expand Down
4 changes: 2 additions & 2 deletions docs/kcl/acos.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Computes the arccosine of a number (in radians).



```
```js
acos(num: number) -> number
```

### Examples

```kcl
```js
const myVar = acos(0.5)
```

Expand Down
6 changes: 3 additions & 3 deletions docs/kcl/angleToMatchLengthX.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Returns the angle to match the given length for x.



```
```js
angleToMatchLengthX(segment_name: string, to: number, sketch_group: SketchGroup) -> number
```

### Examples

```kcl
```js
const part001 = startSketchOn('XY')
|> startProfileAt([0, 0], %)
|> line({ to: [1, 3.82], tag: 'seg01' }, %)
Expand All @@ -30,7 +30,7 @@ const part001 = startSketchOn('XY')
* `segment_name`: `string` (REQUIRED)
* `to`: `number` (REQUIRED)
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down
6 changes: 3 additions & 3 deletions docs/kcl/angleToMatchLengthY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Returns the angle to match the given length for y.



```
```js
angleToMatchLengthY(segment_name: string, to: number, sketch_group: SketchGroup) -> number
```

### Examples

```kcl
```js
const part001 = startSketchOn('XY')
|> startProfileAt([0, 0], %)
|> line({ to: [1, 3.82], tag: 'seg01' }, %)
Expand All @@ -30,7 +30,7 @@ const part001 = startSketchOn('XY')
* `segment_name`: `string` (REQUIRED)
* `to`: `number` (REQUIRED)
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down
10 changes: 5 additions & 5 deletions docs/kcl/angledLine.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Draw an angled line.



```
```js
angledLine(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup
```

### Examples

```kcl
```js
startSketchOn('XY')
|> startProfileAt([0, 0], %)
|> angledLine({ angle: 45, length: 10, tag: "edge1" }, %)
Expand All @@ -27,7 +27,7 @@ startSketchOn('XY')
### Arguments

* `data`: `AngledLineData` - Data to draw an angled line. (REQUIRED)
```
```js
{
// The angle of the line.
angle: number,
Expand All @@ -39,7 +39,7 @@ startSketchOn('XY')
[number, number]
```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down Expand Up @@ -206,7 +206,7 @@ startSketchOn('XY')
### Returns

`SketchGroup` - A sketch group is a collection of paths.
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down
10 changes: 5 additions & 5 deletions docs/kcl/angledLineOfXLength.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Draw an angled line of a given x length.



```
```js
angledLineOfXLength(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup
```

### Examples

```kcl
```js
startSketchOn('XZ')
|> startProfileAt([0, 0], %)
|> angledLineOfXLength({ angle: 45, length: 10, tag: "edge1" }, %)
Expand All @@ -27,7 +27,7 @@ startSketchOn('XZ')
### Arguments

* `data`: `AngledLineData` - Data to draw an angled line. (REQUIRED)
```
```js
{
// The angle of the line.
angle: number,
Expand All @@ -39,7 +39,7 @@ startSketchOn('XZ')
[number, number]
```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down Expand Up @@ -206,7 +206,7 @@ startSketchOn('XZ')
### Returns

`SketchGroup` - A sketch group is a collection of paths.
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down
10 changes: 5 additions & 5 deletions docs/kcl/angledLineOfYLength.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Draw an angled line of a given y length.



```
```js
angledLineOfYLength(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup
```

### Examples

```kcl
```js
startSketchOn('YZ')
|> startProfileAt([0, 0], %)
|> angledLineOfYLength({ angle: 45, length: 10, tag: "edge1" }, %)
Expand All @@ -28,7 +28,7 @@ startSketchOn('YZ')
### Arguments

* `data`: `AngledLineData` - Data to draw an angled line. (REQUIRED)
```
```js
{
// The angle of the line.
angle: number,
Expand All @@ -40,7 +40,7 @@ startSketchOn('YZ')
[number, number]
```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down Expand Up @@ -207,7 +207,7 @@ startSketchOn('YZ')
### Returns

`SketchGroup` - A sketch group is a collection of paths.
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down
10 changes: 5 additions & 5 deletions docs/kcl/angledLineThatIntersects.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Draw an angled line that intersects with a given line.



```
```js
angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch_group: SketchGroup) -> SketchGroup
```

### Examples

```kcl
```js
const part001 = startSketchOn('XY')
|> startProfileAt([0, 0], %)
|> lineTo({ to: [2, 2], tag: "yo" }, %)
Expand All @@ -33,7 +33,7 @@ const part001 = startSketchOn('XY')
### Arguments

* `data`: `AngledLineThatIntersectsData` - Data for drawing an angled line that intersects with a given line. (REQUIRED)
```
```js
{
// The angle of the line.
angle: number,
Expand All @@ -46,7 +46,7 @@ const part001 = startSketchOn('XY')
}
```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down Expand Up @@ -213,7 +213,7 @@ const part001 = startSketchOn('XY')
### Returns

`SketchGroup` - A sketch group is a collection of paths.
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down
10 changes: 5 additions & 5 deletions docs/kcl/angledLineToX.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Draw an angled line to a given x coordinate.



```
```js
angledLineToX(data: AngledLineToData, sketch_group: SketchGroup) -> SketchGroup
```

### Examples

```kcl
```js
startSketchOn('XY')
|> startProfileAt([0, 0], %)
|> angledLineToX({ angle: 45, to: 10, tag: "edge1" }, %)
Expand All @@ -28,7 +28,7 @@ startSketchOn('XY')
### Arguments

* `data`: `AngledLineToData` - Data to draw an angled line to a point. (REQUIRED)
```
```js
{
// The angle of the line.
angle: number,
Expand All @@ -40,7 +40,7 @@ startSketchOn('XY')
[number, number]
```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down Expand Up @@ -207,7 +207,7 @@ startSketchOn('XY')
### Returns

`SketchGroup` - A sketch group is a collection of paths.
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down
10 changes: 5 additions & 5 deletions docs/kcl/angledLineToY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Draw an angled line to a given y coordinate.



```
```js
angledLineToY(data: AngledLineToData, sketch_group: SketchGroup) -> SketchGroup
```

### Examples

```kcl
```js
startSketchOn('XY')
|> startProfileAt([0, 0], %)
|> angledLineToY({ angle: 45, to: 10, tag: "edge1" }, %)
Expand All @@ -27,7 +27,7 @@ startSketchOn('XY')
### Arguments

* `data`: `AngledLineToData` - Data to draw an angled line to a point. (REQUIRED)
```
```js
{
// The angle of the line.
angle: number,
Expand All @@ -39,7 +39,7 @@ startSketchOn('XY')
[number, number]
```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down Expand Up @@ -206,7 +206,7 @@ startSketchOn('XY')
### Returns

`SketchGroup` - A sketch group is a collection of paths.
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down
10 changes: 5 additions & 5 deletions docs/kcl/arc.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Draw an arc.



```
```js
arc(data: ArcData, sketch_group: SketchGroup) -> SketchGroup
```

### Examples

```kcl
```js
startSketchOn('-YZ')
|> startProfileAt([0, 0], %)
|> arc({
Expand All @@ -29,7 +29,7 @@ startSketchOn('-YZ')
### Arguments

* `data`: `ArcData` - Data to draw an arc. (REQUIRED)
```
```js
{
// The end angle.
angle_end: number,
Expand All @@ -52,7 +52,7 @@ startSketchOn('-YZ')
}
```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down Expand Up @@ -219,7 +219,7 @@ startSketchOn('-YZ')
### Returns

`SketchGroup` - A sketch group is a collection of paths.
```
```js
{
// The plane id or face id of the sketch group.
entityId: uuid,
Expand Down
4 changes: 2 additions & 2 deletions docs/kcl/asin.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Computes the arcsine of a number (in radians).



```
```js
asin(num: number) -> number
```

### Examples

```kcl
```js
const myVar = asin(0.5)
```

Expand Down
Loading
Loading