Update KCL docs (#563)

YOYO NEW KCL DOCS!!

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: zoo-github-actions-auth[bot]

content/pages/docs/kcl-std/assert.md

@@ -0,0 +1,50 @@
+---
+title: "assert"
+subtitle: "Function in std"
+excerpt: ""
+layout: manual
+---
+
+
+
+```kcl
+assert(
+  @actual: number,
+  isGreaterThan?: number,
+  isLessThan?: number,
+  isGreaterThanOrEqual?: number,
+  isLessThanOrEqual?: number,
+  isEqualTo?: number,
+  tolerance?: number,
+  error?: string,
+)
+```
+
+Check a value meets some expected conditions at runtime. Program terminates with an error if conditions aren't met.
+If you provide multiple conditions, they will all be checked and all must be met.
+
+### Arguments
+
+| Name | Type | Description | Required |
+|----------|------|-------------|----------|
+| `actual` | [`number`](/docs/kcl-std/types/std-types-number) | Value to check. If this is the boolean value true, assert passes. Otherwise it fails.. | Yes |
+| `isGreaterThan` | [`number`](/docs/kcl-std/types/std-types-number) | Comparison argument. If given, checks the `actual` value is greater than this. | No |
+| `isLessThan` | [`number`](/docs/kcl-std/types/std-types-number) | Comparison argument. If given, checks the `actual` value is less than this. | No |
+| `isGreaterThanOrEqual` | [`number`](/docs/kcl-std/types/std-types-number) | Comparison argument. If given, checks the `actual` value is greater than or equal to this. | No |
+| `isLessThanOrEqual` | [`number`](/docs/kcl-std/types/std-types-number) | Comparison argument. If given, checks the `actual` value is less than or equal to this. | No |
+| `isEqualTo` | [`number`](/docs/kcl-std/types/std-types-number) | Comparison argument. If given, checks the `actual` value is less than or equal to this. | No |
+| `tolerance` | [`number`](/docs/kcl-std/types/std-types-number) | If `isEqualTo` is used, this is the tolerance to allow for the comparison. This tolerance is used because KCL's number system has some floating-point imprecision when used with very large decimal places. | No |
+| `error` | [`string`](/docs/kcl-std/types/std-types-string) | If the value was false, the program will terminate with this error message | No |
+
+
+### Examples
+
+```kcl
+n = 10
+assert(n, isEqualTo = 10)
+assert(n, isGreaterThanOrEqual = 0, isLessThan = 100, error = "number should be between 0 and 100")
+assert(1.0000000000012, isEqualTo = 1, tolerance = 0.0001, error = "number should be almost exactly 1")
+```
+
+
+

content/pages/docs/kcl-std/assertIs.md

@@ -0,0 +1,35 @@
+---
+title: "assertIs"
+subtitle: "Function in std"
+excerpt: "Asserts that a value is the boolean value true."
+layout: manual
+---
+
+Asserts that a value is the boolean value true.
+
+```kcl
+assertIs(
+  @actual: bool,
+  error?: string,
+)
+```
+
+
+
+### Arguments
+
+| Name | Type | Description | Required |
+|----------|------|-------------|----------|
+| `actual` | [`bool`](/docs/kcl-std/types/std-types-bool) | Value to check. If this is the boolean value true, assert passes. Otherwise it fails.. | Yes |
+| `error` | [`string`](/docs/kcl-std/types/std-types-string) | If the value was false, the program will terminate with this error message | No |
+
+
+### Examples
+
+```kcl
+kclIsFun = true
+assertIs(kclIsFun)
+```
+
+
+

content/pages/docs/kcl-std/functions/std-assert.md

@@ -9,7 +9,7 @@ layout: manual
 
 ```kcl
 circle(
-  @sketch_or_surface: Sketch | Plane | Face,
+  @sketchOrSurface: Sketch | Plane | Face,
   center: Point2d,
   radius?: number(Length),
   diameter?: number(Length),
@@ -24,7 +24,7 @@ the provided (x, y) origin point.
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketch_or_surface` | [`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 |
+| `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 |
 | `center` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | The center of the circle. | Yes |
 | `radius` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The radius of the circle. Incompatible with `diameter`. | No |
 | `diameter` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The diameter of the circle. Incompatible with `radius`. | No |

content/pages/docs/kcl-std/functions/std-assertIs.md

@@ -9,11 +9,11 @@ Construct a circle derived from 3 points.
 
 ```kcl
 circleThreePoint(
-  @sketchSurfaceOrGroup: Sketch | Plane | Face,
+  @sketchOrSurface: Sketch | Plane | Face,
   p1: Point2d,
   p2: Point2d,
   p3: Point2d,
-  tag?: TagDeclarator,
+  tag?: tag,
 ): Sketch
 ```
 
@@ -23,11 +23,11 @@ circleThreePoint(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketchSurfaceOrGroup` | [`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) | Plane or surface to sketch on. | Yes |
+| `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) | Plane or surface to sketch on. | Yes |
 | `p1` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | 1st point to derive the circle. | Yes |
 | `p2` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | 2nd point to derive the circle. | Yes |
 | `p3` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | 3rd point to derive the circle. | Yes |
-| [`tag`](/docs/kcl-std/types/std-types-tag) | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | Identifier for the circle to reference elsewhere. | No |
+| [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Identifier for the circle to reference elsewhere. | No |
 
 ### Returns
 
@@ -38,7 +38,7 @@ circleThreePoint(
 
 ```kcl
 exampleSketch = startSketchOn(XY)
-  |> circleThreePoint(p1 = [10, 10], p2 = [20, 8], p3 = [15, 5])
+  |> circleThreePoint(p1 = [10,10], p2 = [20,8], p3 = [15,5])
   |> extrude(length = 5)
 ```
 

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

@@ -1,39 +1,43 @@
 ---
 title: "extrude"
 subtitle: "Function in std::sketch"
-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."
+excerpt: ""
 layout: manual
 ---
 
-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.
+
 
 ```kcl
 extrude(
-  @sketches: [Sketch],
-  length: number,
+  @sketches: [Sketch; 1+],
+  length: number(Length),
   symmetric?: bool,
-  bidirectionalLength?: number,
-  tagStart?: TagDeclarator,
-  tagEnd?: TagDeclarator,
-): [Solid]
+  bidirectionalLength?: number(Length),
+  tagStart?: tag,
+  tagEnd?: tag,
+): [Solid; 1+]
 ```
 
-You can provide more than one sketch to extrude, and they will all be extruded in the same direction.
+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.
+
+You can provide more than one sketch to extrude, and they will all be
+extruded in the same direction.
 
 ### Arguments
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketches` | [`[Sketch]`](/docs/kcl-std/types/std-types-Sketch) | Which sketch or sketches should be extruded | Yes |
-| `length` | [`number`](/docs/kcl-std/types/std-types-number) | How far to extrude the given sketches | Yes |
+| `sketches` | [`[Sketch; 1+]`](/docs/kcl-std/types/std-types-Sketch) | Which sketch or sketches should be extruded. | Yes |
+| `length` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | How far to extrude the given sketches. | Yes |
 | `symmetric` | [`bool`](/docs/kcl-std/types/std-types-bool) | If true, the extrusion will happen symmetrically around the sketch. Otherwise, the extrusion will happen on only one side of the sketch. | No |
-| `bidirectionalLength` | [`number`](/docs/kcl-std/types/std-types-number) | If specified, will also extrude in the opposite direction to 'distance' to the specified distance. If 'symmetric' is true, this value is ignored. | No |
-| `tagStart` | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | A named tag for the face at the start of the extrusion, i.e. the original sketch | No |
-| `tagEnd` | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | A named tag for the face at the end of the extrusion, i.e. the new face created by extruding the original sketch | No |
+| `bidirectionalLength` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | If specified, will also extrude in the opposite direction to 'distance' to the specified distance. If 'symmetric' is true, this value is ignored. | No |
+| `tagStart` | [`tag`](/docs/kcl-std/types/std-types-tag) | A named tag for the face at the start of the extrusion, i.e. the original sketch. | No |
+| `tagEnd` | [`tag`](/docs/kcl-std/types/std-types-tag) | A named tag for the face at the end of the extrusion, i.e. the new face created by extruding the original sketch. | No |
 
 ### Returns
 
-[`[Solid]`](/docs/kcl-std/types/std-types-Solid)
+[`[Solid; 1+]`](/docs/kcl-std/types/std-types-Solid)
 
 
 ### Examples
@@ -42,10 +46,18 @@ You can provide more than one sketch to extrude, and they will all be extruded i
 example = startSketchOn(XZ)
   |> startProfile(at = [0, 0])
   |> line(end = [10, 0])
-  |> arc(angleStart = 120, angleEnd = 0, radius = 5)
+  |> arc(
+    angleStart = 120,
+    angleEnd = 0,
+    radius = 5,
+  )
   |> line(end = [5, 0])
   |> line(end = [0, 10])
-  |> bezierCurve(control1 = [-10, 0], control2 = [2, 10], end = [-5, 10])
+  |> bezierCurve(
+       control1 = [-10, 0],
+       control2 = [2, 10],
+       end = [-5, 10],
+     )
   |> line(end = [-5, -2])
   |> close()
   |> extrude(length = 10)
@@ -56,10 +68,18 @@ example = startSketchOn(XZ)
 ```kcl
 exampleSketch = startSketchOn(XZ)
   |> startProfile(at = [-10, 0])
-  |> arc(angleStart = 120, angleEnd = -60, radius = 5)
+  |> arc(
+    angleStart = 120,
+    angleEnd = -60,
+    radius = 5,
+  )
   |> line(end = [10, 0])
   |> line(end = [5, 0])
-  |> bezierCurve(control1 = [-3, 0], control2 = [2, 10], end = [-5, 10])
+  |> bezierCurve(
+       control1 = [-3, 0],
+       control2 = [2, 10],
+       end = [-5, 10],
+     )
   |> line(end = [-4, 10])
   |> line(end = [-5, -2])
   |> close()
@@ -72,10 +92,18 @@ example = extrude(exampleSketch, length = 10)
 ```kcl
 exampleSketch = startSketchOn(XZ)
   |> startProfile(at = [-10, 0])
-  |> arc(angleStart = 120, angleEnd = -60, radius = 5)
+  |> arc(
+    angleStart = 120,
+    angleEnd = -60,
+    radius = 5,
+  )
   |> line(end = [10, 0])
   |> line(end = [5, 0])
-  |> bezierCurve(control1 = [-3, 0], control2 = [2, 10], end = [-5, 10])
+  |> bezierCurve(
+       control1 = [-3, 0],
+       control2 = [2, 10],
+       end = [-5, 10],
+     )
   |> line(end = [-4, 10])
   |> line(end = [-5, -2])
   |> close()
@@ -88,10 +116,18 @@ example = extrude(exampleSketch, length = 20, symmetric = true)
 ```kcl
 exampleSketch = startSketchOn(XZ)
   |> startProfile(at = [-10, 0])
-  |> arc(angleStart = 120, angleEnd = -60, radius = 5)
+  |> arc(
+    angleStart = 120,
+    angleEnd = -60,
+    radius = 5,
+  )
   |> line(end = [10, 0])
   |> line(end = [5, 0])
-  |> bezierCurve(control1 = [-3, 0], control2 = [2, 10], end = [-5, 10])
+  |> bezierCurve(
+       control1 = [-3, 0],
+       control2 = [2, 10],
+       end = [-5, 10],
+     )
   |> line(end = [-4, 10])
   |> line(end = [-5, -2])
   |> close()

content/pages/docs/kcl-std/circleThreePoint.md renamed to content/pages/docs/kcl-std/functions/std-sketch-circleThreePoint.md

@@ -1,39 +1,41 @@
 ---
 title: "patternCircular2d"
 subtitle: "Function in std::sketch"
-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 orientation of the solid with respect to the center of the circle is maintained."
+excerpt: ""
 layout: manual
 ---
 
-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 orientation of the solid with respect to the center of the circle is maintained.
+
 
 ```kcl
 patternCircular2d(
-  @sketchSet: [Sketch],
-  instances: number,
+  @sketches: [Sketch; 1+],
+  instances: number(_),
   center: Point2d,
-  arcDegrees?: number,
+  arcDegrees?: number(Angle),
   rotateDuplicates?: bool,
   useOriginal?: bool,
-): [Sketch]
+): [Sketch; 1+]
 ```
 
-
+Repeat a 2-dimensional sketch some number of times along a partial or
+complete circle some specified number of times. Each object mayadditionally be rotated along the circle, ensuring orientation of the
+solid with respect to the center of the circle is maintained.
 
 ### Arguments
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketchSet` | [`[Sketch]`](/docs/kcl-std/types/std-types-Sketch) | Which sketch(es) to pattern | Yes |
-| `instances` | [`number`](/docs/kcl-std/types/std-types-number) | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
+| `sketches` | [`[Sketch; 1+]`](/docs/kcl-std/types/std-types-Sketch) | The sketch(es) to duplicate. | Yes |
+| `instances` | [`number(_)`](/docs/kcl-std/types/std-types-number) | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
 | `center` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | The center about which to make the pattern. This is a 2D vector. | Yes |
-| `arcDegrees` | [`number`](/docs/kcl-std/types/std-types-number) | The arc angle (in degrees) to place the repetitions. Must be greater than 0. Defaults to 360. | No |
-| `rotateDuplicates` | [`bool`](/docs/kcl-std/types/std-types-bool) | Whether or not to rotate the duplicates as they are copied. Defaults to true. | No |
-| `useOriginal` | [`bool`](/docs/kcl-std/types/std-types-bool) | If the target was sketched on an extrusion, setting this will use the original sketch as the target, not the entire joined solid. Defaults to false. | No |
+| `arcDegrees` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
+| `rotateDuplicates` | [`bool`](/docs/kcl-std/types/std-types-bool) | Whether or not to rotate the duplicates as they are copied. | No |
+| `useOriginal` | [`bool`](/docs/kcl-std/types/std-types-bool) | If the target was sketched on an extrusion, setting this will use the original sketch as the target, not the entire joined solid. | No |
 
 ### Returns
 
-[`[Sketch]`](/docs/kcl-std/types/std-types-Sketch)
+[`[Sketch; 1+]`](/docs/kcl-std/types/std-types-Sketch)
 
 
 ### Examples
@@ -49,7 +51,7 @@ exampleSketch = startSketchOn(XZ)
        center = [0, 0],
        instances = 13,
        arcDegrees = 360,
-       rotateDuplicates = true,
+       rotateDuplicates = true
      )
 
 example = extrude(exampleSketch, length = 1)