Skip to content

Update KCL docs #787

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.

Sign up for GitHub

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

Merged
jacebrowning merged 1 commit into from
Mar 26, 2026
Merged

Update KCL docs #787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 content/pages/docs/kcl-std/functions/std-sketch2-arc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "sketch2::arc"
subtitle: "Function in std::sketch2"
excerpt: "A circular arc. The arc segment always sweeps counterclockwise from start to end. To change direction, swap the start and end points."
excerpt: "Create a circular arc. The arc segment always sweeps counterclockwise from start to end. To change direction, swap the start and end points."
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.

A circular arc. The arc segment always sweeps counterclockwise from start to end. To change direction, swap the start and end points.
Create a circular arc. The arc segment always sweeps counterclockwise from start to end. To change direction, swap the start and end points.

```kcl
sketch2::arc(
Expand Down
35 changes: 35 additions & 0 deletions content/pages/docs/kcl-std/functions/std-sketch2-circle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "sketch2::circle"
subtitle: "Function in std::sketch2"
excerpt: "Create a circle in a sketch. The circle segment always has a starting point and sweeps counterclockwise from it."
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.

Create a circle in a sketch. The circle segment always has a starting point and sweeps counterclockwise from it.

```kcl
sketch2::circle(
start: Point2d,
center: Point2d,
construction?: bool,
): Segment
```



### Arguments

| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `start` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | A point in two dimensional space. | Yes |
| `center` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | A point in two dimensional space. | Yes |
| `construction` | [`bool`](/docs/kcl-std/types/std-types-bool) | A boolean value. | No |

### Returns

[`Segment`](/docs/kcl-std/types/std-types-Segment) - A segment of a path in a sketch. It may be a line, arc, or other segment type.



10 changes: 4 additions & 6 deletions content/pages/docs/kcl-std/functions/std-sketch2-line.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
---
title: "sketch2::line"
subtitle: "Function in std::sketch2"
excerpt: ""
excerpt: "Create a straight line segment in a sketch."
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.


Create a straight line segment in a sketch.

```kcl
sketch2::line(
start: Point2d,
end?: Point2d,
midpoint?: Point2d,
end: Point2d,
construction?: bool,
): Segment
```
Expand All @@ -25,8 +24,7 @@ sketch2::line(
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `start` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | A point in two dimensional space. | Yes |
| `end` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | A point in two dimensional space. | No |
| `midpoint` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | A point in two dimensional space. | No |
| `end` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | A point in two dimensional space. | Yes |
| `construction` | [`bool`](/docs/kcl-std/types/std-types-bool) | A boolean value. | No |

### Returns
Expand Down
4 changes: 2 additions & 2 deletions content/pages/docs/kcl-std/functions/std-sketch2-point.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "sketch2::point"
subtitle: "Function in std::sketch2"
excerpt: ""
excerpt: "Create a point in a sketch."
layout: manual
---

**WARNING:** This function is experimental and may change or be removed.


Create a point in a sketch.

```kcl
sketch2::point(at: Point2d): Segment
Expand Down
1 change: 1 addition & 0 deletions content/pages/docs/kcl-std/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ layout: manual
* [**std::sketch2**](/docs/kcl-std/modules/std-sketch2)
* [`sketch2::angle`](/docs/kcl-std/functions/std-sketch2-angle)
* [`sketch2::arc`](/docs/kcl-std/functions/std-sketch2-arc)
* [`sketch2::circle`](/docs/kcl-std/functions/std-sketch2-circle)
* [`sketch2::coincident`](/docs/kcl-std/functions/std-sketch2-coincident)
* [`sketch2::diameter`](/docs/kcl-std/functions/std-sketch2-diameter)
* [`sketch2::distance`](/docs/kcl-std/functions/std-sketch2-distance)
Expand Down
2 changes: 2 additions & 0 deletions content/pages/docs/kcl-std/modules/std-runtime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ excerpt: "Functions for debugging and interacting with the runtime system. "
layout: manual
---

**WARNING:** This module is experimental and may change or be removed.

Functions for debugging and interacting with the runtime system.


Expand Down
3 changes: 3 additions & 0 deletions content/pages/docs/kcl-std/modules/std-sketch2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ excerpt: "Functions for sketch mode 2.0 (constraints version) "
layout: manual
---

**WARNING:** This module is experimental and may change or be removed.

Functions for sketch mode 2.0 (constraints version)


Expand All @@ -15,6 +17,7 @@ Functions for sketch mode 2.0 (constraints version)
* [`sketch2::ORIGIN`](/docs/kcl-std/consts/std-sketch2-ORIGIN)
* [`sketch2::angle`](/docs/kcl-std/functions/std-sketch2-angle)
* [`sketch2::arc`](/docs/kcl-std/functions/std-sketch2-arc)
* [`sketch2::circle`](/docs/kcl-std/functions/std-sketch2-circle)
* [`sketch2::coincident`](/docs/kcl-std/functions/std-sketch2-coincident)
* [`sketch2::diameter`](/docs/kcl-std/functions/std-sketch2-diameter)
* [`sketch2::distance`](/docs/kcl-std/functions/std-sketch2-distance)
Expand Down
Loading