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.

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

Jump to bottom

KCL docs: Better docs for KclValue #4096

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

KCL docs: Better docs for KclValue #4096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52e91e6
KCL docs: Better docs for KclValue
adamchalmers Oct 4, 2024
52bbc30
Update docs
adamchalmers Oct 5, 2024
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/reduce.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ reduce(array: [KclValue], start: KclValue, reduce_fn: FunctionParam) -> KclValue
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `array` | [`[KclValue]`](/docs/kcl/types/KclValue) | | Yes |
| `start` | [`KclValue`](/docs/kcl/types/KclValue) | A memory item. | Yes |
| `start` | [`KclValue`](/docs/kcl/types/KclValue) | Any KCL value. | Yes |
| `reduce_fn` | `FunctionParam` | | Yes |

### Returns

[`KclValue`](/docs/kcl/types/KclValue) - A memory item.
[`KclValue`](/docs/kcl/types/KclValue) - Any KCL value.


### Examples
Expand Down
18 changes: 9 additions & 9 deletions docs/kcl/std.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80912,7 +80912,7 @@
},
"definitions": {
"KclValue": {
"description": "A memory item.",
"description": "Any KCL value.",
"oneOf": [
{
"type": "object",
Expand Down Expand Up @@ -84468,7 +84468,7 @@
"type": "null",
"definitions": {
"KclValue": {
"description": "A memory item.",
"description": "Any KCL value.",
"oneOf": [
{
"type": "object",
Expand Down Expand Up @@ -88028,7 +88028,7 @@
},
"definitions": {
"KclValue": {
"description": "A memory item.",
"description": "Any KCL value.",
"oneOf": [
{
"type": "object",
Expand Down Expand Up @@ -112440,7 +112440,7 @@
},
"definitions": {
"KclValue": {
"description": "A memory item.",
"description": "Any KCL value.",
"oneOf": [
{
"type": "object",
Expand Down Expand Up @@ -115993,7 +115993,7 @@
"schema": {
"$schema": "https://spec.openapis.org/oas/3.0/schema/2019-04-02#/definitions/Schema",
"title": "KclValue",
"description": "A memory item.",
"description": "Any KCL value.",
"oneOf": [
{
"type": "object",
Expand Down Expand Up @@ -116389,7 +116389,7 @@
],
"definitions": {
"KclValue": {
"description": "A memory item.",
"description": "Any KCL value.",
"oneOf": [
{
"type": "object",
Expand Down Expand Up @@ -119945,7 +119945,7 @@
"type": "null",
"definitions": {
"KclValue": {
"description": "A memory item.",
"description": "Any KCL value.",
"oneOf": [
{
"type": "object",
Expand Down Expand Up @@ -123499,7 +123499,7 @@
"schema": {
"$schema": "https://spec.openapis.org/oas/3.0/schema/2019-04-02#/definitions/Schema",
"title": "KclValue",
"description": "A memory item.",
"description": "Any KCL value.",
"oneOf": [
{
"type": "object",
Expand Down Expand Up @@ -127037,7 +127037,7 @@
}
},
"KclValue": {
"description": "A memory item.",
"description": "Any KCL value.",
"oneOf": [
{
"type": "object",
Expand Down
10 changes: 5 additions & 5 deletions docs/kcl/types/KclValue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "KclValue"
excerpt: "A memory item."
excerpt: "Any KCL value."
layout: manual
---

A memory item.
Any KCL value.



Expand Down Expand Up @@ -80,7 +80,7 @@ A plane.
|----------|------|-------------|----------|
| `type` |enum: `Plane`| | No |
| `id` |`string`| The id of the plane. | No |
| `value` |[`PlaneType`](/docs/kcl/types/PlaneType)| A memory item. | No |
| `value` |[`PlaneType`](/docs/kcl/types/PlaneType)| Any KCL value. | No |
| `origin` |[`Point3d`](/docs/kcl/types/Point3d)| Origin of the plane. | No |
| `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s X axis be? | No |
| `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s Y axis be? | No |
Expand Down Expand Up @@ -183,8 +183,8 @@ Data for an imported geometry.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `type` |enum: `Function`| | No |
| `expression` |[`FunctionExpression`](/docs/kcl/types/FunctionExpression)| A memory item. | No |
| `memory` |[`ProgramMemory`](/docs/kcl/types/ProgramMemory)| A memory item. | No |
| `expression` |[`FunctionExpression`](/docs/kcl/types/FunctionExpression)| Any KCL value. | No |
| `memory` |[`ProgramMemory`](/docs/kcl/types/ProgramMemory)| Any KCL value. | No |
| `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`| | No |


Expand Down
2 changes: 1 addition & 1 deletion src/wasm-lib/kcl/src/executor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ impl DynamicState {
}
}

/// A memory item.
/// Any KCL value.
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema)]
#[ts(export)]
#[serde(tag = "type")]
Expand Down
Loading