Code completions for @settings (#5622)

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

.github/workflows/build-and-store-wasm.yml

@@ -22,7 +22,7 @@ jobs:
         uses: Swatinem/rust-cache@v2
         with:
           workspaces: './rust'
-      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+      - uses: taiki-e/install-action@a209ff0ce0349f9e7cadc4ba8f6a415c8d3b0813
         with:
           tool: wasm-pack
       - name: build wasm

.github/workflows/build-apps.yml

@@ -41,7 +41,7 @@ jobs:
           workspaces: './rust'
 
       # TODO: see if we can fetch from main instead if no diff at rust
-      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+      - uses: taiki-e/install-action@a209ff0ce0349f9e7cadc4ba8f6a415c8d3b0813
         with:
           tool: wasm-pack
 
@@ -134,6 +134,7 @@ jobs:
         # Windows is picky sometimes and fails on fetch. Step takes about ~30s
         uses: nick-fields/retry@v3.0.2
         with:
+          shell: bash
           timeout_minutes: 2
           max_attempts: 3
           command: yarn install
@@ -185,6 +186,7 @@ jobs:
         # TODO: Fix electron-notarize flakes. The logs above should help gather more data on failures
         uses: nick-fields/retry@v3.0.2
         with:
+          shell: bash
           timeout_minutes: 10
           max_attempts: 3
           command: yarn tronb:package:prod
@@ -246,6 +248,7 @@ jobs:
         # TODO: Fix electron-notarize flakes. The logs above should help gather more data on failures
         uses: nick-fields/retry@v3.0.2
         with:
+          shell: bash
           timeout_minutes: 10
           max_attempts: 3
           command: yarn tronb:package:prod

.github/workflows/cargo-check.yml

@@ -19,15 +19,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Install latest rust
+      - name: Use correct Rust toolchain
-        uses: actions-rs/toolchain@v1
+        shell: bash
+        run: |
+          cp --update=none rust/rust-toolchain.toml ./ || true
+      - name: Install rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-            toolchain: 1.85
+          cache-workspaces: rust
-            override: true
-            default: true
-
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2.6.1
 
       - name: Run check
         run: |

.github/workflows/cargo-clippy.yml

@@ -26,17 +26,16 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: taiki-e/install-action@just
-      - name: Install latest rust
+      - name: Use correct Rust toolchain
-        uses: actions-rs/toolchain@v1
+        shell: bash
+        run: |
+          cp --update=none rust/rust-toolchain.toml ./ || true
+      - name: Install rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-            toolchain: 1.85
+          cache-workspaces: rust
-            override: true
-            default: true
           components: clippy
 
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2.6.1
-
       - name: Run clippy
         run: |
           cd rust

.github/workflows/cargo-fmt.yml

@@ -28,17 +28,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Install latest rust
+      - name: Use correct Rust toolchain
-        uses: actions-rs/toolchain@v1
+        shell: bash
+        run: |
+          cp --update=none rust/rust-toolchain.toml ./ || true
+      - name: Install rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-            toolchain: 1.85
+          cache-workspaces: rust
-            override: true
-            default: true
           components: rustfmt
 
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2.6.1
-
       - name: Run cargo fmt
         run: |
           cd rust

.github/workflows/cargo-test.yml

@@ -16,12 +16,14 @@ jobs:
     runs-on: ubuntu-latest-8-cores
     steps:
       - uses: actions/checkout@v4
-      - name: Install latest rust
+      - name: Use correct Rust toolchain
-        uses: actions-rs/toolchain@v1
+        shell: bash
+        run: |
+          cp --update=none rust/rust-toolchain.toml ./ || true
+      - name: Install rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-          toolchain: 1.85
+          cache: false # Configured below.
-          override: true
-          default: true
       - name: Install vector
         run: |
           curl --proto '=https' --tlsv1.2 -sSfL https://sh.vector.dev > /tmp/vector.sh
@@ -40,6 +42,8 @@ jobs:
       - uses: taiki-e/install-action@nextest
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2.6.1
+        with:
+          workspaces: rust
       - name: cargo test
         shell: bash
         run: |-

.github/workflows/e2e-tests.yml

@@ -51,6 +51,7 @@ jobs:
         node-version-file: '.nvmrc'
         cache: 'yarn'
     - name: Install dependencies
+      id: deps-install
       shell: bash
       run: yarn
     - name: Cache Playwright Browsers
@@ -80,7 +81,7 @@ jobs:
       continue-on-error: true
     - name: Setup Rust
       uses: dtolnay/rust-toolchain@stable
-    - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+    - uses: taiki-e/install-action@a209ff0ce0349f9e7cadc4ba8f6a415c8d3b0813
       with:
         tool: wasm-pack
     - name: Cache Wasm (because rust diff)
@@ -193,9 +194,10 @@ jobs:
         path: test-results/
     - name: Run playwright/electron flow (with retries)
       id: retry
-      if: ${{ !cancelled() && (success() || failure()) }}
+      if: ${{ !cancelled() && steps.deps-install.outcome == 'success' }}
       uses: nick-fields/retry@v3.0.2
       with:
+        shell: bash
         command: .github/ci-cd-scripts/playwright-electron.sh ${{matrix.shardIndex}} ${{matrix.shardTotal}} ${{matrix.os}}
         timeout_minutes: 30
         max_attempts: 25

.github/workflows/static-analysis.yml

@@ -37,7 +37,7 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'yarn'
       - run: yarn install
-      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+      - uses: taiki-e/install-action@a209ff0ce0349f9e7cadc4ba8f6a415c8d3b0813
         with:
           tool: wasm-pack
       - run: yarn build:wasm
@@ -56,7 +56,7 @@ jobs:
         with:
           workspaces: './rust'
 
-      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+      - uses: taiki-e/install-action@a209ff0ce0349f9e7cadc4ba8f6a415c8d3b0813
         with:
           tool: wasm-pack
       - run: yarn build:wasm
@@ -98,7 +98,7 @@ jobs:
           cache: 'yarn'
 
       - run: yarn install
-      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+      - uses: taiki-e/install-action@a209ff0ce0349f9e7cadc4ba8f6a415c8d3b0813
         with:
           tool: wasm-pack
       - run: yarn build:wasm
@@ -127,7 +127,7 @@ jobs:
           cache: 'yarn'
 
       - run: yarn install
-      - uses: taiki-e/install-action@2dbeb927f58939d3aa13bf06ba0c0a34b76b9bfb
+      - uses: taiki-e/install-action@a209ff0ce0349f9e7cadc4ba8f6a415c8d3b0813
         with:
           tool: wasm-pack
       - run: yarn build:wasm

docs/kcl/abs.md

@@ -9,7 +9,7 @@ Compute the absolute value of a number.
 
 
 ```js
-abs(num: number) -> number
+abs(num: number): number
 ```
 
 ### Tags

docs/kcl/acos.md

@@ -9,7 +9,7 @@ Compute the arccosine of a number (in radians).
 
 
 ```js
-acos(num: number) -> number
+acos(num: number): number
 ```
 
 ### Tags

docs/kcl/angleToMatchLengthX.md

@@ -13,7 +13,7 @@ angleToMatchLengthX(
   tag: TagIdentifier,
   to: number,
   sketch: Sketch,
-) -> number
+): number
 ```
 
 

docs/kcl/angleToMatchLengthY.md

@@ -13,7 +13,7 @@ angleToMatchLengthY(
   tag: TagIdentifier,
   to: number,
   sketch: Sketch,
-) -> number
+): number
 ```
 
 

docs/kcl/angledLine.md

@@ -1,19 +1,19 @@
 ---
 title: "angledLine"
-excerpt: "Draw a line segment relative to the current origin using the polar"
+excerpt: "Draw a line segment relative to the current origin using the polar measure of some angle and distance."
 layout: manual
 ---
 
-Draw a line segment relative to the current origin using the polar
+Draw a line segment relative to the current origin using the polar measure of some angle and distance.
+
 
-measure of some angle and distance.
 
 ```js
 angledLine(
   data: AngledLineData,
   sketch: Sketch,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/angledLineOfXLength.md

@@ -1,19 +1,19 @@
 ---
 title: "angledLineOfXLength"
-excerpt: "Create a line segment from the current 2-dimensional sketch origin"
+excerpt: "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some relative length in the 'x' dimension."
 layout: manual
 ---
 
-Create a line segment from the current 2-dimensional sketch origin
+Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some relative length in the 'x' dimension.
+
 
-along some angle (in degrees) for some relative length in the 'x' dimension.
 
 ```js
 angledLineOfXLength(
   data: AngledLineData,
   sketch: Sketch,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/angledLineOfYLength.md

@@ -1,19 +1,19 @@
 ---
 title: "angledLineOfYLength"
-excerpt: "Create a line segment from the current 2-dimensional sketch origin"
+excerpt: "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some relative length in the 'y' dimension."
 layout: manual
 ---
 
-Create a line segment from the current 2-dimensional sketch origin
+Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some relative length in the 'y' dimension.
+
 
-along some angle (in degrees) for some relative length in the 'y' dimension.
 
 ```js
 angledLineOfYLength(
   data: AngledLineData,
   sketch: Sketch,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/angledLineThatIntersects.md

@@ -1,19 +1,19 @@
 ---
 title: "angledLineThatIntersects"
-excerpt: "Draw an angled line from the current origin, constructing a line segment"
+excerpt: "Draw an angled line from the current origin, constructing a line segment such that the newly created line intersects the desired target line segment."
 layout: manual
 ---
 
-Draw an angled line from the current origin, constructing a line segment
+Draw an angled line from the current origin, constructing a line segment such that the newly created line intersects the desired target line segment.
+
 
-such that the newly created line intersects the desired target line segment.
 
 ```js
 angledLineThatIntersects(
   data: AngledLineThatIntersectsData,
   sketch: Sketch,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/angledLineToX.md

@@ -1,19 +1,19 @@
 ---
 title: "angledLineToX"
-excerpt: "Create a line segment from the current 2-dimensional sketch origin"
+excerpt: "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension."
 layout: manual
 ---
 
-Create a line segment from the current 2-dimensional sketch origin
+Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension.
+
 
-along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension.
 
 ```js
 angledLineToX(
   data: AngledLineToData,
   sketch: Sketch,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/angledLineToY.md

@@ -1,19 +1,19 @@
 ---
 title: "angledLineToY"
-excerpt: "Create a line segment from the current 2-dimensional sketch origin"
+excerpt: "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension."
 layout: manual
 ---
 
-Create a line segment from the current 2-dimensional sketch origin
+Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension.
+
 
-along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension.
 
 ```js
 angledLineToY(
   data: AngledLineToData,
   sketch: Sketch,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/appearance.md

@@ -14,7 +14,7 @@ appearance(
   color: String,
   metalness?: number,
   roughness?: number,
-) -> SolidSet
+): SolidSet
 ```
 
 

docs/kcl/arc.md

@@ -15,7 +15,7 @@ arc(
   data: ArcData,
   sketch: Sketch,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/arcTo.md

@@ -1,10 +1,10 @@
 ---
 title: "arcTo"
-excerpt: "Draw a 3 point arc."
+excerpt: "Draw a three point arc."
 layout: manual
 ---
 
-Draw a 3 point arc.
+Draw a three point arc.
 
 The arc is constructed such that the start point is the current position of the sketch and two more points defined as the end and interior point. The interior point is placed between the start point and end point. The radius of the arc will be controlled by how far the interior point is placed from the start and end.
 
@@ -13,7 +13,7 @@ arcTo(
   data: ArcToData,
   sketch: Sketch,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/asin.md

@@ -9,7 +9,7 @@ Compute the arcsine of a number (in radians).
 
 
 ```js
-asin(num: number) -> number
+asin(num: number): number
 ```
 
 ### Tags

docs/kcl/assert.md

@@ -1,18 +1,18 @@
 ---
 title: "assert"
-excerpt: "Check a value at runtime, and raise an error if the argument provided"
+excerpt: "Check a value at runtime, and raise an error if the argument provided is false."
 layout: manual
 ---
 
-Check a value at runtime, and raise an error if the argument provided
+Check a value at runtime, and raise an error if the argument provided is false.
+
 
-is false.
 
 ```js
 assert(
   data: bool,
   message: string,
-) -> ()
+): ()
 ```
 
 

docs/kcl/assertEqual.md

@@ -1,12 +1,12 @@
 ---
 title: "assertEqual"
-excerpt: "Check that a numerical value equals another at runtime,"
+excerpt: "Check that a numerical value equals another at runtime, otherwise raise an error."
 layout: manual
 ---
 
-Check that a numerical value equals another at runtime,
+Check that a numerical value equals another at runtime, otherwise raise an error.
+
 
-otherwise raise an error.
 
 ```js
 assertEqual(
@@ -14,7 +14,7 @@ assertEqual(
   right: number,
   epsilon: number,
   message: string,
-) -> ()
+): ()
 ```
 
 

docs/kcl/assertGreaterThan.md

@@ -1,19 +1,19 @@
 ---
 title: "assertGreaterThan"
-excerpt: "Check that a numerical value is greater than another at runtime,"
+excerpt: "Check that a numerical value is greater than another at runtime, otherwise raise an error."
 layout: manual
 ---
 
-Check that a numerical value is greater than another at runtime,
+Check that a numerical value is greater than another at runtime, otherwise raise an error.
+
 
-otherwise raise an error.
 
 ```js
 assertGreaterThan(
   left: number,
   right: number,
   message: string,
-) -> ()
+): ()
 ```
 
 

docs/kcl/assertGreaterThanOrEq.md

@@ -1,19 +1,19 @@
 ---
 title: "assertGreaterThanOrEq"
-excerpt: "Check that a numerical value is greater than or equal to another at runtime,"
+excerpt: "Check that a numerical value is greater than or equal to another at runtime, otherwise raise an error."
 layout: manual
 ---
 
-Check that a numerical value is greater than or equal to another at runtime,
+Check that a numerical value is greater than or equal to another at runtime, otherwise raise an error.
+
 
-otherwise raise an error.
 
 ```js
 assertGreaterThanOrEq(
   left: number,
   right: number,
   message: string,
-) -> ()
+): ()
 ```
 
 

docs/kcl/assertLessThan.md

@@ -1,19 +1,19 @@
 ---
 title: "assertLessThan"
-excerpt: "Check that a numerical value is less than to another at runtime,"
+excerpt: "Check that a numerical value is less than to another at runtime, otherwise raise an error."
 layout: manual
 ---
 
-Check that a numerical value is less than to another at runtime,
+Check that a numerical value is less than to another at runtime, otherwise raise an error.
+
 
-otherwise raise an error.
 
 ```js
 assertLessThan(
   left: number,
   right: number,
   message: string,
-) -> ()
+): ()
 ```
 
 

docs/kcl/assertLessThanOrEq.md

@@ -1,19 +1,19 @@
 ---
 title: "assertLessThanOrEq"
-excerpt: "Check that a numerical value is less than or equal to another at runtime,"
+excerpt: "Check that a numerical value is less than or equal to another at runtime, otherwise raise an error."
 layout: manual
 ---
 
-Check that a numerical value is less than or equal to another at runtime,
+Check that a numerical value is less than or equal to another at runtime, otherwise raise an error.
+
 
-otherwise raise an error.
 
 ```js
 assertLessThanOrEq(
   left: number,
   right: number,
   message: string,
-) -> ()
+): ()
 ```
 
 

docs/kcl/atan.md

@@ -9,7 +9,7 @@ Compute the arctangent of a number (in radians).
 
 
 ```js
-atan(num: number) -> number
+atan(num: number): number
 ```
 
 ### Tags

docs/kcl/atan2.md

@@ -12,7 +12,7 @@ Compute the four quadrant arctangent of Y and X (in radians).
 atan2(
   y: number,
   x: number,
-) -> number
+): number
 ```
 
 ### Tags

docs/kcl/bezierCurve.md

@@ -1,19 +1,19 @@
 ---
 title: "bezierCurve"
-excerpt: "Draw a smooth, continuous, curved line segment from the current origin to"
+excerpt: "Draw a smooth, continuous, curved line segment from the current origin to the desired (x, y), using a number of control points to shape the curve's shape."
 layout: manual
 ---
 
-Draw a smooth, continuous, curved line segment from the current origin to
+Draw a smooth, continuous, curved line segment from the current origin to the desired (x, y), using a number of control points to shape the curve's shape.
+
 
-the desired (x, y), using a number of control points to shape the curve's shape.
 
 ```js
 bezierCurve(
   data: BezierData,
   sketch: Sketch,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/ceil.md

@@ -9,7 +9,7 @@ Compute the smallest integer greater than or equal to a number.
 
 
 ```js
-ceil(num: number) -> number
+ceil(num: number): number
 ```
 
 ### Tags

docs/kcl/chamfer.md

@@ -14,7 +14,7 @@ chamfer(
   length: number,
   tags: [EdgeReference],
   tag?: TagDeclarator,
-) -> Solid
+): Solid
 ```
 
 

docs/kcl/circle.md

@@ -1,12 +1,12 @@
 ---
 title: "circle"
-excerpt: "Construct a 2-dimensional circle, of the specified radius, centered at"
+excerpt: "Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point."
 layout: manual
 ---
 
-Construct a 2-dimensional circle, of the specified radius, centered at
+Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point.
+
 
-the provided (x, y) origin point.
 
 ```js
 circle(
@@ -14,7 +14,7 @@ circle(
   center: [number],
   radius: number,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/circleThreePoint.md

@@ -15,7 +15,7 @@ circleThreePoint(
   p3: [number],
   sketchSurfaceOrGroup: SketchOrSurface,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/close.md

@@ -1,18 +1,18 @@
 ---
 title: "close"
-excerpt: "Construct a line segment from the current origin back to the profile's"
+excerpt: "Construct a line segment from the current origin back to the profile's origin, ensuring the resulting 2-dimensional sketch is not open-ended."
 layout: manual
 ---
 
-Construct a line segment from the current origin back to the profile's
+Construct a line segment from the current origin back to the profile's origin, ensuring the resulting 2-dimensional sketch is not open-ended.
+
 
-origin, ensuring the resulting 2-dimensional sketch is not open-ended.
 
 ```js
 close(
   sketch: Sketch,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/cm.md

@@ -15,7 +15,7 @@ For example, if the current project uses inches, this function will return `0.39
 We merely provide these functions for convenience and readability, as `10 * cm()` is more readable that your intent is "I want 10 centimeters" than `10 * 10`, if the project settings are in millimeters.
 
 ```js
-cm() -> number
+cm(): number
 ```
 
 ### Tags

docs/kcl/e.md

@@ -11,7 +11,7 @@ Return the value of Euler’s number `e`.
 **DEPRECATED** use the constant E
 
 ```js
-e() -> number
+e(): number
 ```
 
 ### Tags

docs/kcl/extrude.md

@@ -1,18 +1,18 @@
 ---
 title: "extrude"
-excerpt: "Extend a 2-dimensional sketch through a third dimension in order to"
+excerpt: "Extend a 2-dimensional sketch through a third dimension in order to create new 3-dimensional volume, or if extruded into an existing volume, cut into an existing solid."
 layout: manual
 ---
 
-Extend a 2-dimensional sketch through a third dimension in order to
+Extend a 2-dimensional sketch through a third dimension in order to create new 3-dimensional volume, or if extruded into an existing volume, cut into an existing solid.
+
 
-create new 3-dimensional volume, or if extruded into an existing volume, cut into an existing solid.
 
 ```js
 extrude(
   sketchSet: SketchSet,
   length: number,
-) -> SolidSet
+): SolidSet
 ```
 
 

docs/kcl/fillet.md

@@ -15,7 +15,7 @@ fillet(
   tags: [EdgeReference],
   tolerance?: number,
   tag?: TagDeclarator,
-) -> Solid
+): Solid
 ```
 
 

docs/kcl/floor.md

@@ -9,7 +9,7 @@ Compute the largest integer less than or equal to a number.
 
 
 ```js
-floor(num: number) -> number
+floor(num: number): number
 ```
 
 ### Tags

docs/kcl/ft.md

@@ -15,7 +15,7 @@ For example, if the current project uses inches, this function will return `12`.
 We merely provide these functions for convenience and readability, as `10 * ft()` is more readable that your intent is "I want 10 feet" than `10 * 304.8`, if the project settings are in millimeters.
 
 ```js
-ft() -> number
+ft(): number
 ```
 
 ### Tags

docs/kcl/getNextAdjacentEdge.md

@@ -9,7 +9,7 @@ Get the next adjacent edge to the edge given.
 
 
 ```js
-getNextAdjacentEdge(tag: TagIdentifier) -> Uuid
+getNextAdjacentEdge(tag: TagIdentifier): Uuid
 ```
 
 

docs/kcl/getOppositeEdge.md

@@ -9,7 +9,7 @@ Get the opposite edge to the edge given.
 
 
 ```js
-getOppositeEdge(tag: TagIdentifier) -> Uuid
+getOppositeEdge(tag: TagIdentifier): Uuid
 ```
 
 

docs/kcl/getPreviousAdjacentEdge.md

@@ -9,7 +9,7 @@ Get the previous adjacent edge to the edge given.
 
 
 ```js
-getPreviousAdjacentEdge(tag: TagIdentifier) -> Uuid
+getPreviousAdjacentEdge(tag: TagIdentifier): Uuid
 ```
 
 

docs/kcl/helix.md

@@ -16,7 +16,7 @@ helix(
   radius: number,
   axis: Axis3dOrEdgeReference,
   length?: number,
-) -> HelixValue
+): HelixValue
 ```
 
 

docs/kcl/helixRevolutions.md

@@ -12,7 +12,7 @@ Create a helix on a cylinder.
 helixRevolutions(
   data: HelixRevolutionsData,
   solid: Solid,
-) -> Solid
+): Solid
 ```
 
 

docs/kcl/hole.md

@@ -12,7 +12,7 @@ Use a 2-dimensional sketch to cut a hole in another 2-dimensional sketch.
 hole(
   holeSketch: SketchSet,
   sketch: Sketch,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/hollow.md

@@ -12,7 +12,7 @@ Remove volume from a 3-dimensional shape such that a wall of the provided thickn
 hollow(
   thickness: number,
   solid: Solid,
-) -> Solid
+): Solid
 ```
 
 

docs/kcl/import.md

@@ -18,7 +18,7 @@ Note: The import command currently only works when using the native Modeling App
 import(
   filePath: String,
   options?: ImportFormat,
-) -> ImportedGeometry
+): ImportedGeometry
 ```
 
 

docs/kcl/inch.md

@@ -15,7 +15,7 @@ For example, if the current project uses inches, this function will return `1`.
 We merely provide these functions for convenience and readability, as `10 * inch()` is more readable that your intent is "I want 10 inches" than `10 * 25.4`, if the project settings are in millimeters.
 
 ```js
-inch() -> number
+inch(): number
 ```
 
 ### Tags

docs/kcl/int.md

@@ -11,7 +11,7 @@ Convert a number to an integer.
 DEPRECATED use floor(), ceil(), or round().
 
 ```js
-int(num: number) -> number
+int(num: number): number
 ```
 
 ### Tags

docs/kcl/lastSegX.md

@@ -1,15 +1,15 @@
 ---
 title: "lastSegX"
-excerpt: "Extract the 'x' axis value of the last line segment in the provided 2-d"
+excerpt: "Extract the 'x' axis value of the last line segment in the provided 2-d sketch."
 layout: manual
 ---
 
-Extract the 'x' axis value of the last line segment in the provided 2-d
+Extract the 'x' axis value of the last line segment in the provided 2-d sketch.
+
 
-sketch.
 
 ```js
-lastSegX(sketch: Sketch) -> number
+lastSegX(sketch: Sketch): number
 ```
 
 

docs/kcl/lastSegY.md

@@ -1,15 +1,15 @@
 ---
 title: "lastSegY"
-excerpt: "Extract the 'y' axis value of the last line segment in the provided 2-d"
+excerpt: "Extract the 'y' axis value of the last line segment in the provided 2-d sketch."
 layout: manual
 ---
 
-Extract the 'y' axis value of the last line segment in the provided 2-d
+Extract the 'y' axis value of the last line segment in the provided 2-d sketch.
+
 
-sketch.
 
 ```js
-lastSegY(sketch: Sketch) -> number
+lastSegY(sketch: Sketch): number
 ```
 
 

docs/kcl/legAngX.md

@@ -12,7 +12,7 @@ Compute the angle of the given leg for x.
 legAngX(
   hypotenuse: number,
   leg: number,
-) -> number
+): number
 ```
 
 ### Tags

docs/kcl/legAngY.md

@@ -12,7 +12,7 @@ Compute the angle of the given leg for y.
 legAngY(
   hypotenuse: number,
   leg: number,
-) -> number
+): number
 ```
 
 ### Tags

docs/kcl/legLen.md

@@ -12,7 +12,7 @@ Compute the length of the given leg.
 legLen(
   hypotenuse: number,
   leg: number,
-) -> number
+): number
 ```
 
 ### Tags

docs/kcl/line.md

@@ -14,7 +14,7 @@ line(
   endAbsolute?: [number],
   end?: [number],
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/ln.md

@@ -9,7 +9,7 @@ Compute the natural logarithm of the number.
 
 
 ```js
-ln(num: number) -> number
+ln(num: number): number
 ```
 
 ### Tags

docs/kcl/loft.md

@@ -15,7 +15,7 @@ loft(
   bezApproximateRational: bool,
   baseCurveIndex?: integer,
   tolerance?: number,
-) -> Solid
+): Solid
 ```
 
 

docs/kcl/log.md

@@ -12,7 +12,7 @@ The result might not be correctly rounded owing to implementation details; `log2
 log(
   num: number,
   base: number,
-) -> number
+): number
 ```
 
 ### Tags

docs/kcl/log10.md

@@ -9,7 +9,7 @@ Compute the base 10 logarithm of the number.
 
 
 ```js
-log10(num: number) -> number
+log10(num: number): number
 ```
 
 ### Tags

docs/kcl/log2.md

@@ -9,7 +9,7 @@ Compute the base 2 logarithm of the number.
 
 
 ```js
-log2(num: number) -> number
+log2(num: number): number
 ```
 
 ### Tags

docs/kcl/m.md

@@ -15,7 +15,7 @@ For example, if the current project uses inches, this function will return `39.3
 We merely provide these functions for convenience and readability, as `10 * m()` is more readable that your intent is "I want 10 meters" than `10 * 1000`, if the project settings are in millimeters.
 
 ```js
-m() -> number
+m(): number
 ```
 
 ### Tags

docs/kcl/map.md

@@ -12,7 +12,7 @@ Given a list like `[a, b, c]`, and a function like `f`, returns `[f(a), f(b), f(
 map(
   array: [KclValue],
   mapFn: FunctionSource,
-) -> [KclValue]
+): [KclValue]
 ```
 
 

docs/kcl/max.md

@@ -9,7 +9,7 @@ Compute the maximum of the given arguments.
 
 
 ```js
-max(args: [number]) -> number
+max(args: [number]): number
 ```
 
 ### Tags

docs/kcl/min.md

@@ -9,7 +9,7 @@ Compute the minimum of the given arguments.
 
 
 ```js
-min(args: [number]) -> number
+min(args: [number]): number
 ```
 
 ### Tags

docs/kcl/mirror2d.md

@@ -14,7 +14,7 @@ Mirror occurs around a local sketch axis rather than a global axis.
 mirror2d(
   data: Mirror2dData,
   sketchSet: SketchSet,
-) -> [Sketch]
+): [Sketch]
 ```
 
 

docs/kcl/mm.md

@@ -15,7 +15,7 @@ For example, if the current project uses inches, this function will return `(1/2
 We merely provide these functions for convenience and readability, as `10 * mm()` is more readable that your intent is "I want 10 millimeters" than `10 * (1/25.4)`, if the project settings are in inches.
 
 ```js
-mm() -> number
+mm(): number
 ```
 
 ### Tags

docs/kcl/offsetPlane.md

@@ -12,7 +12,7 @@ For example, if you offset the 'XZ' plane by 10, the new plane will be parallel
 offsetPlane(
   plane: PlaneData,
   offset: number,
-) -> Plane
+): Plane
 ```
 
 

docs/kcl/patternCircular2d.md

@@ -1,12 +1,12 @@
 ---
 title: "patternCircular2d"
-excerpt: "Repeat a 2-dimensional sketch some number of times along a partial or"
+excerpt: "Repeat a 2-dimensional sketch some number of times along a partial or complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained."
 layout: manual
 ---
 
-Repeat a 2-dimensional sketch some number of times along a partial or
+Repeat a 2-dimensional sketch some number of times along a partial or complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained.
+
 
-complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained.
 
 ```js
 patternCircular2d(
@@ -16,7 +16,7 @@ patternCircular2d(
   arcDegrees: number,
   rotateDuplicates: bool,
   useOriginal?: bool,
-) -> [Sketch]
+): [Sketch]
 ```
 
 

docs/kcl/patternCircular3d.md

@@ -1,12 +1,12 @@
 ---
 title: "patternCircular3d"
-excerpt: "Repeat a 3-dimensional solid some number of times along a partial or"
+excerpt: "Repeat a 3-dimensional solid some number of times along a partial or complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained."
 layout: manual
 ---
 
-Repeat a 3-dimensional solid some number of times along a partial or
+Repeat a 3-dimensional solid some number of times along a partial or complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained.
+
 
-complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained.
 
 ```js
 patternCircular3d(
@@ -17,7 +17,7 @@ patternCircular3d(
   arcDegrees: number,
   rotateDuplicates: bool,
   useOriginal?: bool,
-) -> [Solid]
+): [Solid]
 ```
 
 

docs/kcl/patternLinear2d.md

@@ -1,12 +1,12 @@
 ---
 title: "patternLinear2d"
-excerpt: "Repeat a 2-dimensional sketch along some dimension, with a dynamic amount"
+excerpt: "Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of distance between each repetition, some specified number of times."
 layout: manual
 ---
 
-Repeat a 2-dimensional sketch along some dimension, with a dynamic amount
+Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of distance between each repetition, some specified number of times.
+
 
-of distance between each repetition, some specified number of times.
 
 ```js
 patternLinear2d(
@@ -15,7 +15,7 @@ patternLinear2d(
   distance: number,
   axis: [number],
   useOriginal?: bool,
-) -> [Sketch]
+): [Sketch]
 ```
 
 

docs/kcl/patternLinear3d.md

@@ -1,12 +1,10 @@
 ---
 title: "patternLinear3d"
-excerpt: "Repeat a 3-dimensional solid along a linear path, with a dynamic amount"
+excerpt: "Repeat a 3-dimensional solid along a linear path, with a dynamic amount of distance between each repetition, some specified number of times."
 layout: manual
 ---
 
-Repeat a 3-dimensional solid along a linear path, with a dynamic amount
+Repeat a 3-dimensional solid along a linear path, with a dynamic amount of distance between each repetition, some specified number of times.
-
-of distance between each repetition, some specified number of times.
 
 ///
 
@@ -17,7 +15,7 @@ patternLinear3d(
   distance: number,
   axis: [number],
   useOriginal?: bool,
-) -> [Solid]
+): [Solid]
 ```
 
 

docs/kcl/patternTransform.md

@@ -40,7 +40,7 @@ patternTransform(
   instances: integer,
   transform: FunctionSource,
   useOriginal?: bool,
-) -> [Solid]
+): [Solid]
 ```
 
 

docs/kcl/patternTransform2d.md

@@ -14,7 +14,7 @@ patternTransform2d(
   instances: integer,
   transform: FunctionSource,
   useOriginal?: bool,
-) -> [Sketch]
+): [Sketch]
 ```
 
 

docs/kcl/pi.md

@@ -11,7 +11,7 @@ Return the value of `pi`. Archimedes’ constant (π).
 **DEPRECATED** use the constant PI
 
 ```js
-pi() -> number
+pi(): number
 ```
 
 ### Tags

docs/kcl/polar.md

@@ -1,15 +1,15 @@
 ---
 title: "polar"
-excerpt: "Convert polar/sphere (azimuth, elevation, distance) coordinates to"
+excerpt: "Convert polar/sphere (azimuth, elevation, distance) coordinates to cartesian (x/y/z grid) coordinates."
 layout: manual
 ---
 
-Convert polar/sphere (azimuth, elevation, distance) coordinates to
+Convert polar/sphere (azimuth, elevation, distance) coordinates to cartesian (x/y/z grid) coordinates.
+
 
-cartesian (x/y/z grid) coordinates.
 
 ```js
-polar(data: PolarCoordsData) -> [number]
+polar(data: PolarCoordsData): [number]
 ```
 
 

docs/kcl/polygon.md

@@ -13,7 +13,7 @@ polygon(
   data: PolygonData,
   sketchSurfaceOrGroup: SketchOrSurface,
   tag?: TagDeclarator,
-) -> Sketch
+): Sketch
 ```
 
 

docs/kcl/pop.md

@@ -9,7 +9,7 @@ Remove the last element from an array.
 Returns a new array with the last element removed.
 
 ```js
-pop(array: [KclValue]) -> KclValue
+pop(array: [KclValue]): KclValue
 ```
 
 

docs/kcl/pow.md

@@ -12,7 +12,7 @@ Compute the number to a power.
 pow(
   num: number,
   pow: number,
-) -> number
+): number
 ```
 
 ### Tags

docs/kcl/profileStart.md

@@ -1,15 +1,15 @@
 ---
 title: "profileStart"
-excerpt: "Extract the provided 2-dimensional sketch's profile's origin"
+excerpt: "Extract the provided 2-dimensional sketch's profile's origin value."
 layout: manual
 ---
 
-Extract the provided 2-dimensional sketch's profile's origin
+Extract the provided 2-dimensional sketch's profile's origin value.
+
 
-value.
 
 ```js
-profileStart(sketch: Sketch) -> [number]
+profileStart(sketch: Sketch): [number]
 ```
 
 

docs/kcl/profileStartX.md

@@ -1,15 +1,15 @@
 ---
 title: "profileStartX"
-excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'x'"
+excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'x' value."
 layout: manual
 ---
 
-Extract the provided 2-dimensional sketch's profile's origin's 'x'
+Extract the provided 2-dimensional sketch's profile's origin's 'x' value.
+
 
-value.
 
 ```js
-profileStartX(sketch: Sketch) -> number
+profileStartX(sketch: Sketch): number
 ```
 
 

docs/kcl/profileStartY.md

@@ -1,15 +1,15 @@
 ---
 title: "profileStartY"
-excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'y'"
+excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'y' value."
 layout: manual
 ---
 
-Extract the provided 2-dimensional sketch's profile's origin's 'y'
+Extract the provided 2-dimensional sketch's profile's origin's 'y' value.
+
 
-value.
 
 ```js
-profileStartY(sketch: Sketch) -> number
+profileStartY(sketch: Sketch): number
 ```
 
 

docs/kcl/push.md

@@ -12,7 +12,7 @@ Returns a new array with the element appended.
 push(
   array: [KclValue],
   elem: KclValue,
-) -> KclValue
+): KclValue
 ```
 
 

docs/kcl/reduce.md

@@ -1,19 +1,19 @@
 ---
 title: "reduce"
-excerpt: "Take a starting value. Then, for each element of an array, calculate the next value,"
+excerpt: "Take a starting value. Then, for each element of an array, calculate the next value, using the previous value and the element."
 layout: manual
 ---
 
-Take a starting value. Then, for each element of an array, calculate the next value,
+Take a starting value. Then, for each element of an array, calculate the next value, using the previous value and the element.
+
 
-using the previous value and the element.
 
 ```js
 reduce(
   array: [KclValue],
   start: KclValue,
   reduceFn: FunctionSource,
-) -> KclValue
+): KclValue
 ```
 
 

docs/kcl/rem.md

@@ -1,18 +1,18 @@
 ---
 title: "rem"
-excerpt: "Compute the remainder after dividing `num` by `div`."
+excerpt: "Compute the remainder after dividing `num` by `div`. If `num` is negative, the result will be too."
 layout: manual
 ---
 
-Compute the remainder after dividing `num` by `div`.
+Compute the remainder after dividing `num` by `div`. If `num` is negative, the result will be too.
+
 
-If `num` is negative, the result will be too.
 
 ```js
 rem(
   num: number,
   divisor: number,
-) -> number
+): number
 ```
 
 ### Tags

docs/kcl/revolve.md

@@ -14,7 +14,7 @@ Revolve occurs around a local sketch axis rather than a global axis.
 revolve(
   data: RevolveData,
   sketch: Sketch,
-) -> Solid
+): Solid
 ```
 
 

docs/kcl/rotate.md

@@ -31,7 +31,7 @@ rotate(
   axis?: [number],
   angle?: number,
   global?: bool,
-) -> Solid
+): Solid
 ```
 
 

docs/kcl/round.md

@@ -9,7 +9,7 @@ Round a number to the nearest integer.
 
 
 ```js
-round(num: number) -> number
+round(num: number): number
 ```
 
 ### Tags

docs/kcl/scale.md

@@ -15,7 +15,7 @@ scale(
   solid: Solid,
   scale: [number],
   global?: bool,
-) -> Solid
+): Solid
 ```
 
 

docs/kcl/segAng.md

@@ -9,7 +9,7 @@ Compute the angle (in degrees) of the provided line segment.
 
 
 ```js
-segAng(tag: TagIdentifier) -> number
+segAng(tag: TagIdentifier): number
 ```
 
 

docs/kcl/segEnd.md

@@ -9,7 +9,7 @@ Compute the ending point of the provided line segment.
 
 
 ```js
-segEnd(tag: TagIdentifier) -> [number]
+segEnd(tag: TagIdentifier): [number]
 ```
 
 

docs/kcl/segEndX.md

@@ -9,7 +9,7 @@ Compute the ending point of the provided line segment along the 'x' axis.
 
 
 ```js
-segEndX(tag: TagIdentifier) -> number
+segEndX(tag: TagIdentifier): number
 ```
 
 

docs/kcl/segEndY.md

@@ -9,7 +9,7 @@ Compute the ending point of the provided line segment along the 'y' axis.
 
 
 ```js
-segEndY(tag: TagIdentifier) -> number
+segEndY(tag: TagIdentifier): number
 ```
 
 

docs/kcl/segLen.md

@@ -9,7 +9,7 @@ Compute the length of the provided line segment.
 
 
 ```js
-segLen(tag: TagIdentifier) -> number
+segLen(tag: TagIdentifier): number
 ```
 
 

docs/kcl/segStart.md

@@ -9,7 +9,7 @@ Compute the starting point of the provided line segment.
 
 
 ```js
-segStart(tag: TagIdentifier) -> [number]
+segStart(tag: TagIdentifier): [number]
 ```
 
 

docs/kcl/segStartX.md

@@ -9,7 +9,7 @@ Compute the starting point of the provided line segment along the 'x' axis.
 
 
 ```js
-segStartX(tag: TagIdentifier) -> number
+segStartX(tag: TagIdentifier): number
 ```
 
 

docs/kcl/segStartY.md

@@ -9,7 +9,7 @@ Compute the starting point of the provided line segment along the 'y' axis.
 
 
 ```js
-segStartY(tag: TagIdentifier) -> number
+segStartY(tag: TagIdentifier): number
 ```
 
 

docs/kcl/shell.md

@@ -1,19 +1,19 @@
 ---
 title: "shell"
-excerpt: "Remove volume from a 3-dimensional shape such that a wall of the"
+excerpt: "Remove volume from a 3-dimensional shape such that a wall of the provided thickness remains, taking volume starting at the provided face, leaving it open in that direction."
 layout: manual
 ---
 
-Remove volume from a 3-dimensional shape such that a wall of the
+Remove volume from a 3-dimensional shape such that a wall of the provided thickness remains, taking volume starting at the provided face, leaving it open in that direction.
+
 
-provided thickness remains, taking volume starting at the provided face, leaving it open in that direction.
 
 ```js
 shell(
   solidSet: SolidSet,
   thickness: number,
   faces: [FaceTag],
-) -> SolidSet
+): SolidSet
 ```