Misc docs polishing (#6712)

* Fake modules for Rust std lib functions

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

* Include the missing @ in Rust std lib fns

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

* Move revolve and mirror2d to better modules

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

* Use docs from KCL mods for type summaries

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

* Use type docs to describe types from KCL std lib

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-06 16:09:59 +12:00
committed by GitHub
parent 1e056cfd8a
commit 1841e63021
116 changed files with 1178 additions and 1095 deletions

View File

@ -34,7 +34,7 @@ helix(
### Returns
[`Helix`](/docs/kcl-std/types/std-types-Helix)
[`Helix`](/docs/kcl-std/types/std-types-Helix) - A helix.
### Examples

View File

@ -16,11 +16,11 @@ abs(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -16,11 +16,11 @@ ceil(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -16,11 +16,11 @@ floor(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -16,11 +16,11 @@ ln(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -26,7 +26,7 @@ log(
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -16,11 +16,11 @@ log10(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -16,11 +16,11 @@ log2(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -20,7 +20,7 @@ max(@input: [number; 1+]): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -20,7 +20,7 @@ min(@input: [number; 1+]): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -25,7 +25,7 @@ polar(
### Returns
[`Point2d`](/docs/kcl-std/types/std-types-Point2d)
[`Point2d`](/docs/kcl-std/types/std-types-Point2d) - A point in two dimensional space.
### Examples

View File

@ -24,7 +24,7 @@ pow(
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -25,7 +25,7 @@ rem(
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -16,11 +16,11 @@ round(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -16,11 +16,11 @@ sqrt(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number)
[`number`](/docs/kcl-std/types/std-types-number) - A number
### Examples

View File

@ -25,7 +25,7 @@ offsetPlane(
### Returns
[`Plane`](/docs/kcl-std/types/std-types-Plane)
[`Plane`](/docs/kcl-std/types/std-types-Plane) - A plane.
### Examples

File diff suppressed because one or more lines are too long

View File

@ -29,7 +29,7 @@ circle(
### Returns
[`Sketch`](/docs/kcl-std/types/std-types-Sketch)
[`Sketch`](/docs/kcl-std/types/std-types-Sketch) - A sketch is a collection of paths.
### Examples

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -30,7 +30,7 @@ chamfer(
### Returns
[`Solid`](/docs/kcl-std/types/std-types-Solid)
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extrude surfaces.
### Examples

View File

@ -32,7 +32,7 @@ fillet(
### Returns
[`Solid`](/docs/kcl-std/types/std-types-Solid)
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extrude surfaces.
### Examples

View File

@ -25,7 +25,7 @@ hollow(
### Returns
[`Solid`](/docs/kcl-std/types/std-types-Solid)
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extrude surfaces.
### Examples

File diff suppressed because one or more lines are too long