Skip to content

Commit 72d72fd

Browse files
Update KCL docs (#627)
YOYO NEW KCL DOCS!! Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 44ef298 commit 72d72fd

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

content/pages/docs/kcl-std/functions/std-sketch-ellipse.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ Construct a 2-dimensional ellipse, of the specified major/minor radius, centered
1111
ellipse(
1212
@sketchOrSurface: Sketch | Plane | Face,
1313
center: Point2d,
14-
majorRadius: number(Length),
1514
minorRadius: number(Length),
15+
majorRadius?: number(Length),
16+
majorAxis?: Point2d,
1617
tag?: tag,
1718
): Sketch
1819
```
@@ -25,8 +26,9 @@ ellipse(
2526
|----------|------|-------------|----------|
2627
| `sketchOrSurface` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) or [`Plane`](/docs/kcl-std/types/std-types-Plane) or [`Face`](/docs/kcl-std/types/std-types-Face) | Sketch to extend, or plane or surface to sketch on. | Yes |
2728
| `center` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | The center of the ellipse. | Yes |
28-
| `majorRadius` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The major radius of the ellipse. | Yes |
2929
| `minorRadius` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The minor radius of the ellipse. | Yes |
30+
| `majorRadius` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The major radius of the ellipse. Equivalent to majorAxis = [majorRadius, 0]. | No |
31+
| `majorAxis` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | The major axis of the ellipse. | No |
3032
| `tag` | `tag` | Create a new tag which refers to this ellipse. | No |
3133

3234
### Returns

content/pages/docs/kcl-std/functions/std-sketch-elliptic.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ elliptic(
1313
center: Point2d,
1414
angleStart: number(Angle),
1515
angleEnd: number(Angle),
16-
majorRadius: number(Length),
1716
minorRadius: number(Length),
17+
majorRadius?: number(Length),
18+
majorAxis?: Point2d,
1819
tag?: tag,
1920
): Sketch
2021
```
@@ -29,8 +30,9 @@ elliptic(
2930
| `center` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | The center of the ellipse. | Yes |
3031
| `angleStart` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | Where along the ellptic should this segment start? | Yes |
3132
| `angleEnd` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | Where along the ellptic should this segment end? | Yes |
32-
| `majorRadius` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The major radius, a, of the elliptic equation x^2 / a^2 + y^2 / b^2 = 1. | Yes |
3333
| `minorRadius` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The minor radius, b, of the elliptic equation x^2 / a^2 + y^2 / b^2 = 1. | Yes |
34+
| `majorRadius` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The major radius, a, of the elliptic equation x^2 / a^2 + y^2 / b^2 = 1. Equivalent to majorAxis = [majorRadius, 0]. | No |
35+
| `majorAxis` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | The major axis of the elliptic. | No |
3436
| `tag` | `tag` | Create a new tag which refers to this arc. | No |
3537

3638
### Returns

0 commit comments

Comments
 (0)