Merge branch 'main' into achalmers/kw-args-chamfer

docs/kcl/startSketchOn.md

@@ -6,7 +6,15 @@ layout: manual
 
 Start a new 2-dimensional sketch on a specific plane or face.
 
+### Sketch on Face Behavior
 
+There are some important behaviors to understand when sketching on a face:
+
+The resulting sketch will _include_ the face and thus Solid that was sketched on. So say you were to export the resulting Sketch / Solid from a sketch on a face, you would get both the artifact of the sketch on the face and the parent face / Solid itself.
+
+This is important to understand because if you were to then sketch on the resulting Solid, it would again include the face and parent Solid that was sketched on. This could go on indefinitely.
+
+The point is if you want to export the result of a sketch on a face, you only need to export the final Solid that was created from the sketch on the face, since it will include all the parent faces and Solids.
 
 ```js
 startSketchOn(data: SketchData, tag?: FaceTag) -> SketchSurface

docs/kcl/std.json

@@ -213811,11 +213811,30 @@
             },
             "length": {
               "description": "The length of the line.",
-              "type": "number",
-              "format": "double"
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/TyF64"
+                }
+              ]
             }
           },
           "definitions": {
+            "TyF64": {
+              "type": "object",
+              "required": [
+                "n",
+                "ty"
+              ],
+              "properties": {
+                "n": {
+                  "type": "number",
+                  "format": "double"
+                },
+                "ty": {
+                  "$ref": "#/components/schemas/NumericType"
+                }
+              }
+            },
             "NumericType": {
               "oneOf": [
                 {
@@ -277734,7 +277753,7 @@
   {
     "name": "startSketchOn",
     "summary": "Start a new 2-dimensional sketch on a specific plane or face.",
-    "description": "",
+    "description": "### Sketch on Face Behavior\n\nThere are some important behaviors to understand when sketching on a face:\n\nThe resulting sketch will _include_ the face and thus Solid that was sketched on. So say you were to export the resulting Sketch / Solid from a sketch on a face, you would get both the artifact of the sketch on the face and the parent face / Solid itself.\n\nThis is important to understand because if you were to then sketch on the resulting Solid, it would again include the face and parent Solid that was sketched on. This could go on indefinitely.\n\nThe point is if you want to export the result of a sketch on a face, you only need to export the final Solid that was created from the sketch on the face, since it will include all the parent faces and Solids.",
     "tags": [],
     "keywordArguments": false,
     "args": [

docs/kcl/types/BasePath.md

@@ -18,7 +18,7 @@ A base path.
 |----------|------|-------------|----------|
 | `from` |`[number, number]`| The from point. | No |
 | `to` |`[number, number]`| The to point. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A base path. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 

docs/kcl/types/EnvironmentRef.md

@@ -1,9 +1,10 @@
 ---
 title: "EnvironmentRef"
-excerpt: ""
+excerpt: "An index pointing to a snapshot within a specific (unspecified) environment."
 layout: manual
 ---
 
+An index pointing to a snapshot within a specific (unspecified) environment.
 
 [`SnapshotRef`](/docs/kcl/types/SnapshotRef)
 

docs/kcl/types/ExtrudeSurface.md

@@ -28,7 +28,7 @@ An extrude plane.
 | `faceId` |`string`| The face id for the extrude plane. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag. | No |
 | `id` |`string`| The id of the geometry. | No |
-| `sourceRange` |`SourceRange`| The source range. | No |
+| `sourceRange` |[`SourceRange`](/docs/kcl/types/SourceRange)| The source range. | No |
 
 
 ----
@@ -48,7 +48,7 @@ An extruded arc.
 | `faceId` |`string`| The face id for the extrude plane. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag. | No |
 | `id` |`string`| The id of the geometry. | No |
-| `sourceRange` |`SourceRange`| The source range. | No |
+| `sourceRange` |[`SourceRange`](/docs/kcl/types/SourceRange)| The source range. | No |
 
 
 ----
@@ -68,7 +68,7 @@ Geometry metadata.
 | `faceId` |`string`| The id for the chamfer surface. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag. | No |
 | `id` |`string`| The id of the geometry. | No |
-| `sourceRange` |`SourceRange`| The source range. | No |
+| `sourceRange` |[`SourceRange`](/docs/kcl/types/SourceRange)| The source range. | No |
 
 
 ----
@@ -88,7 +88,7 @@ Geometry metadata.
 | `faceId` |`string`| The id for the fillet surface. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag. | No |
 | `id` |`string`| The id of the geometry. | No |
-| `sourceRange` |`SourceRange`| The source range. | No |
+| `sourceRange` |[`SourceRange`](/docs/kcl/types/SourceRange)| The source range. | No |
 
 
 ----

docs/kcl/types/Face.md

@@ -23,7 +23,7 @@ A face.
 | `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face's Y axis be? | No |
 | `zAxis` |[`Point3d`](/docs/kcl/types/Point3d)| The z-axis (normal). | No |
 | `solid` |[`Solid`](/docs/kcl/types/Solid)| The solid the face is on. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A face. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 

docs/kcl/types/FaceTag.md

@@ -11,7 +11,6 @@ A tag for a face.
 
 **This schema accepts any of the following:**
 
-A tag for a face.
 
 [`StartOrEnd`](/docs/kcl/types/StartOrEnd)
 

docs/kcl/types/GeoMeta.md

@@ -17,6 +17,6 @@ Geometry metadata.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `id` |`string`| The id of the geometry. | No |
-| `sourceRange` |`SourceRange`| The source range. | No |
+| `sourceRange` |[`SourceRange`](/docs/kcl/types/SourceRange)| The source range. | No |
 
 

docs/kcl/types/Helix.md

@@ -21,7 +21,7 @@ A helix.
 | `revolutions` |`number`| Number of revolutions. | No |
 | `angleStart` |`number`| Start angle (in degrees). | No |
 | `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A helix. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 

docs/kcl/types/HelixValue.md

@@ -21,7 +21,7 @@ A helix.
 | `revolutions` |`number`| Number of revolutions. | No |
 | `angleStart` |`number`| Start angle (in degrees). | No |
 | `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A helix. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 

docs/kcl/types/KclValue.md

@@ -59,7 +59,7 @@ Any KCL value.
 |----------|------|-------------|----------|
 | `type` |enum: `Number`|  | No |
 | `value` |`number`|  | No |
-| `ty` |[`NumericType`](/docs/kcl/types/NumericType)| Any KCL value. | No |
+| `ty` |[`NumericType`](/docs/kcl/types/NumericType)|  | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 
@@ -164,7 +164,7 @@ Any KCL value.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`Plane`](/docs/kcl/types/Plane)|  | No |
-| `value` |[`Plane`](/docs/kcl/types/Plane)| Any KCL value. | No |
+| `value` |[`Plane`](/docs/kcl/types/Plane)| A plane. | No |
 
 
 ----
@@ -180,7 +180,7 @@ Any KCL value.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`Face`](/docs/kcl/types/Face)|  | No |
-| `value` |[`Face`](/docs/kcl/types/Face)| Any KCL value. | No |
+| `value` |[`Face`](/docs/kcl/types/Face)| A face. | No |
 
 
 ----
@@ -196,7 +196,7 @@ Any KCL value.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`Sketch`](/docs/kcl/types/Sketch)|  | No |
-| `value` |[`Sketch`](/docs/kcl/types/Sketch)| Any KCL value. | No |
+| `value` |[`Sketch`](/docs/kcl/types/Sketch)| A sketch is a collection of paths. | No |
 
 
 ----
@@ -228,7 +228,7 @@ Any KCL value.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`Solid`](/docs/kcl/types/Solid)|  | No |
-| `value` |[`Solid`](/docs/kcl/types/Solid)| Any KCL value. | No |
+| `value` |[`Solid`](/docs/kcl/types/Solid)| A solid is a collection of extrude surfaces. | No |
 
 
 ----
@@ -260,7 +260,7 @@ Any KCL value.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`Helix`](/docs/kcl/types/Helix)|  | No |
-| `value` |[`Helix`](/docs/kcl/types/Helix)| Any KCL value. | No |
+| `value` |[`Helix`](/docs/kcl/types/Helix)| A helix. | No |
 
 
 ----
@@ -312,7 +312,7 @@ Data for an imported geometry.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: `Module`|  | No |
-| `value` |[`ModuleId`](/docs/kcl/types/ModuleId)| Any KCL value. | No |
+| `value` |[`ModuleId`](/docs/kcl/types/ModuleId)| Identifier of a source file.  Uses a u32 to keep the size small. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 
@@ -329,7 +329,7 @@ Data for an imported geometry.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: [`KclNone`](/docs/kcl/types/KclNone)|  | No |
-| `value` |[`KclNone`](/docs/kcl/types/KclNone)| Any KCL value. | No |
+| `value` |[`KclNone`](/docs/kcl/types/KclNone)| KCL value for an optional parameter which was not given an argument. (remember, parameters are in the function declaration, arguments are in the function call/application). | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 

docs/kcl/types/Metadata.md

@@ -16,6 +16,6 @@ Metadata.
 
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sourceRange` |`SourceRange`| The source range. | No |
+| `sourceRange` |[`SourceRange`](/docs/kcl/types/SourceRange)| The source range. | No |
 
 

docs/kcl/types/NumericType.md

@@ -211,8 +211,8 @@ A unit of angle.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `type` |enum: `Default`|  | No |
-| `len` |[`UnitLen`](/docs/kcl/types/UnitLen)|  | No |
-| `angle` |[`UnitAngle`](/docs/kcl/types/UnitAngle)|  | No |
+| `len` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
+| `angle` |[`UnitAngle`](/docs/kcl/types/UnitAngle)| A unit of angle. | No |
 
 
 ----

docs/kcl/types/Path.md

@@ -27,7 +27,7 @@ A path that goes to a point.
 | `type` |enum: `ToPoint`|  | No |
 | `from` |`[number, number]`| The from point. | No |
 | `to` |`[number, number]`| The to point. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A path. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 
@@ -50,7 +50,7 @@ A arc that is tangential to the last path segment that goes to a point
 | `ccw` |`boolean`| arc's direction | No |
 | `from` |`[number, number]`| The from point. | No |
 | `to` |`[number, number]`| The to point. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A path. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 
@@ -73,7 +73,7 @@ A arc that is tangential to the last path segment
 | `ccw` |`boolean`| arc's direction | No |
 | `from` |`[number, number]`| The from point. | No |
 | `to` |`[number, number]`| The to point. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A path. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 
@@ -97,7 +97,7 @@ a complete arc
 | `ccw` |`boolean`| arc's direction This is used to compute the tangential angle. | No |
 | `from` |`[number, number]`| The from point. | No |
 | `to` |`[number, number]`| The to point. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A path. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 
@@ -121,7 +121,7 @@ A base path.
 | `p3` |`[number, number]`| Point 3 of the circle | No |
 | `from` |`[number, number]`| The from point. | No |
 | `to` |`[number, number]`| The to point. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A path. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 
@@ -143,7 +143,7 @@ A path that is horizontal.
 | `x` |`number`| The x coordinate. | No |
 | `from` |`[number, number]`| The from point. | No |
 | `to` |`[number, number]`| The to point. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A path. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 
@@ -166,7 +166,7 @@ An angled line to.
 | `y` |`number`| The y coordinate. | No |
 | `from` |`[number, number]`| The from point. | No |
 | `to` |`[number, number]`| The to point. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A path. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 
@@ -187,7 +187,7 @@ A base path.
 | `type` |enum: `Base`|  | No |
 | `from` |`[number, number]`| The from point. | No |
 | `to` |`[number, number]`| The to point. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A path. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 
@@ -211,7 +211,7 @@ A circular arc, not necessarily tangential to the current point.
 | `ccw` |`boolean`| True if the arc is counterclockwise. | No |
 | `from` |`[number, number]`| The from point. | No |
 | `to` |`[number, number]`| The to point. | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A path. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
 

docs/kcl/types/Plane.md

@@ -18,12 +18,12 @@ A plane.
 |----------|------|-------------|----------|
 | `id` |`string`| The id of the plane. | No |
 | `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The artifact ID. | No |
-| `value` |[`PlaneType`](/docs/kcl/types/PlaneType)| A plane. | No |
+| `value` |[`PlaneType`](/docs/kcl/types/PlaneType)| Type for a plane. | 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 |
 | `zAxis` |[`Point3d`](/docs/kcl/types/Point3d)| The z-axis (normal). | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A plane. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 

docs/kcl/types/PolarCoordsData.md

@@ -17,6 +17,6 @@ Data for polar coordinates.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `angle` |`number`| The angle of the line (in degrees). | No |
-| `length` |`number`| The length of the line. | No |
+| `length` |[`TyF64`](/docs/kcl/types/TyF64)| The length of the line. | No |
 
 

docs/kcl/types/Sketch.md

@@ -57,7 +57,7 @@ You can still execute _new_ commands on the sketch like `extrude`, `revolve`, `l
 | `tags` |`object`| Tag identifiers that have been declared in this sketch. | No |
 | `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The original id of the sketch. This stays the same even if the sketch is is sketched on face etc. | No |
 | `originalId` |`string`|  | No |
-| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A sketch is a collection of paths. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A unit of length. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`| Metadata. | No |