diff --git a/docs/kcl-src/modules.md b/docs/kcl-src/modules.md index 262780c51..47c4daa9a 100644 --- a/docs/kcl-src/modules.md +++ b/docs/kcl-src/modules.md @@ -12,7 +12,7 @@ to other modules. ```kcl // util.kcl -export fn increment(x) { +export fn increment(@x) { return x + 1 } ``` @@ -37,11 +37,11 @@ Multiple functions can be exported in a file. ```kcl // util.kcl -export fn increment(x) { +export fn increment(@x) { return x + 1 } -export fn decrement(x) { +export fn decrement(@x) { return x - 1 } ``` @@ -81,7 +81,7 @@ fn cube(center) { |> extrude(length = 10) } -myCube = cube([0, 0]) +myCube = cube(center = [0, 0]) ``` *Pros* diff --git a/docs/kcl-src/types.md b/docs/kcl-src/types.md index c1c4ef22f..7cea7be5a 100644 --- a/docs/kcl-src/types.md +++ b/docs/kcl-src/types.md @@ -249,8 +249,8 @@ fn rect(origin) { |> close() } -rect([0, 0]) -rect([20, 0]) +rect(origin = [0, 0]) +rect(origin = [20, 0]) ``` Those tags would only be available in the `rect` function and not globally. @@ -279,8 +279,8 @@ fn rect(origin) { |> close() } -rect([0, 0]) -myRect = rect([20, 0]) +rect(origin = [0, 0]) +myRect = rect(origin = [20, 0]) myRect |> extrude(length = 10) diff --git a/docs/kcl/angledLine.md b/docs/kcl/angledLine.md index bf270eb6c..70fc315af 100644 --- a/docs/kcl/angledLine.md +++ b/docs/kcl/angledLine.md @@ -10,15 +10,15 @@ Draw a line segment relative to the current origin using the polar measure of so ```kcl angledLine( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - angle: [number](/docs/kcl/types/std-types-number), - length?: [number](/docs/kcl/types/std-types-number), - lengthX?: [number](/docs/kcl/types/std-types-number), - lengthY?: [number](/docs/kcl/types/std-types-number), - endAbsoluteX?: [number](/docs/kcl/types/std-types-number), - endAbsoluteY?: [number](/docs/kcl/types/std-types-number), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + angle: number, + length?: number, + lengthX?: number, + lengthY?: number, + endAbsoluteX?: number, + endAbsoluteY?: number, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/angledLineThatIntersects.md b/docs/kcl/angledLineThatIntersects.md index 88b55a929..aa5d08743 100644 --- a/docs/kcl/angledLineThatIntersects.md +++ b/docs/kcl/angledLineThatIntersects.md @@ -10,12 +10,12 @@ Draw an angled line from the current origin, constructing a line segment such th ```kcl angledLineThatIntersects( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - angle: [number](/docs/kcl/types/std-types-number), - intersectTag: [TagIdentifier](/docs/kcl/types#TagIdentifier), - offset?: [number](/docs/kcl/types/std-types-number), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + angle: number, + intersectTag: TagIdentifier, + offset?: number, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/appearance.md b/docs/kcl/appearance.md index c1dcc87fa..4cb592631 100644 --- a/docs/kcl/appearance.md +++ b/docs/kcl/appearance.md @@ -10,11 +10,11 @@ This will work on any solid, including extruded solids, revolved solids, and she ```kcl appearance( - solids: [[Solid]](/docs/kcl/types/std-types-Solid) | [ImportedGeometry](/docs/kcl/types#ImportedGeometry), - color: [string](/docs/kcl/types/std-types-string), - metalness?: [number](/docs/kcl/types/std-types-number), - roughness?: [number](/docs/kcl/types/std-types-number), -): [[Solid]](/docs/kcl/types/std-types-Solid) | [ImportedGeometry](/docs/kcl/types#ImportedGeometry) + solids: [Solid] | ImportedGeometry, + color: string, + metalness?: number, + roughness?: number, +): [Solid] | ImportedGeometry ``` diff --git a/docs/kcl/arc.md b/docs/kcl/arc.md index 9ee6f3857..f38d50477 100644 --- a/docs/kcl/arc.md +++ b/docs/kcl/arc.md @@ -12,14 +12,14 @@ Unless this makes a lot of sense and feels like what you're looking for to const ```kcl arc( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - angleStart?: [number](/docs/kcl/types/std-types-number), - angleEnd?: [number](/docs/kcl/types/std-types-number), - radius?: [number](/docs/kcl/types/std-types-number), - interiorAbsolute?: [Point2d](/docs/kcl/types/std-types-Point2d), - endAbsolute?: [Point2d](/docs/kcl/types/std-types-Point2d), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + angleStart?: number, + angleEnd?: number, + radius?: number, + interiorAbsolute?: Point2d, + endAbsolute?: Point2d, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/assert.md b/docs/kcl/assert.md index 854e04f77..e0e3caabf 100644 --- a/docs/kcl/assert.md +++ b/docs/kcl/assert.md @@ -10,14 +10,14 @@ Check a value meets some expected conditions at runtime. Program terminates with ```kcl assert( - actual: [number](/docs/kcl/types/std-types-number), - isGreaterThan?: [number](/docs/kcl/types/std-types-number), - isLessThan?: [number](/docs/kcl/types/std-types-number), - isGreaterThanOrEqual?: [number](/docs/kcl/types/std-types-number), - isLessThanOrEqual?: [number](/docs/kcl/types/std-types-number), - isEqualTo?: [number](/docs/kcl/types/std-types-number), - tolerance?: [number](/docs/kcl/types/std-types-number), - error?: [string](/docs/kcl/types/std-types-string), + actual: number, + isGreaterThan?: number, + isLessThan?: number, + isGreaterThanOrEqual?: number, + isLessThanOrEqual?: number, + isEqualTo?: number, + tolerance?: number, + error?: string, ): () ``` diff --git a/docs/kcl/assertIs.md b/docs/kcl/assertIs.md index d91db499f..78593851a 100644 --- a/docs/kcl/assertIs.md +++ b/docs/kcl/assertIs.md @@ -10,8 +10,8 @@ Asserts that a value is the boolean value true. ```kcl assertIs( - actual: [bool](/docs/kcl/types/std-types-bool), - error?: [string](/docs/kcl/types/std-types-string), + actual: bool, + error?: string, ): () ``` diff --git a/docs/kcl/bezierCurve.md b/docs/kcl/bezierCurve.md index 4f566944c..27b9ccd99 100644 --- a/docs/kcl/bezierCurve.md +++ b/docs/kcl/bezierCurve.md @@ -10,12 +10,12 @@ Draw a smooth, continuous, curved line segment from the current origin to the de ```kcl bezierCurve( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - control1: [Point2d](/docs/kcl/types/std-types-Point2d), - control2: [Point2d](/docs/kcl/types/std-types-Point2d), - end: [Point2d](/docs/kcl/types/std-types-Point2d), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + control1: Point2d, + control2: Point2d, + end: Point2d, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/circleThreePoint.md b/docs/kcl/circleThreePoint.md index d4983c628..07158f0e2 100644 --- a/docs/kcl/circleThreePoint.md +++ b/docs/kcl/circleThreePoint.md @@ -10,12 +10,12 @@ Construct a circle derived from 3 points. ```kcl circleThreePoint( - sketchSurfaceOrGroup: [Sketch](/docs/kcl/types/std-types-Sketch) | [Plane](/docs/kcl/types/std-types-Plane) | [Face](/docs/kcl/types/std-types-Face), - p1: [Point2d](/docs/kcl/types/std-types-Point2d), - p2: [Point2d](/docs/kcl/types/std-types-Point2d), - p3: [Point2d](/docs/kcl/types/std-types-Point2d), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketchSurfaceOrGroup: Sketch | Plane | Face, + p1: Point2d, + p2: Point2d, + p3: Point2d, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/clone.md b/docs/kcl/clone.md index aa6f1f338..37f51ef55 100644 --- a/docs/kcl/clone.md +++ b/docs/kcl/clone.md @@ -13,7 +13,7 @@ This doesn't really have much utility unless you need the equivalent of a double Really only use this function if YOU ARE SURE you need it. In most cases you do not need clone and using a pattern with `instance = 2` is more appropriate. ```kcl -clone(geometry: [Solid](/docs/kcl/types/std-types-Solid) | [Sketch](/docs/kcl/types/std-types-Sketch) | [ImportedGeometry](/docs/kcl/types#ImportedGeometry)): [Solid](/docs/kcl/types/std-types-Solid) | [Sketch](/docs/kcl/types/std-types-Sketch) | [ImportedGeometry](/docs/kcl/types#ImportedGeometry) +clone(geometry: Solid | Sketch | ImportedGeometry): Solid | Sketch | ImportedGeometry ``` diff --git a/docs/kcl/close.md b/docs/kcl/close.md index 57fd602e1..dd731e779 100644 --- a/docs/kcl/close.md +++ b/docs/kcl/close.md @@ -10,9 +10,9 @@ Construct a line segment from the current origin back to the profile's origin, e ```kcl close( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/extrude.md b/docs/kcl/extrude.md index 996056e94..6c9e0ebdf 100644 --- a/docs/kcl/extrude.md +++ b/docs/kcl/extrude.md @@ -10,13 +10,13 @@ You can provide more than one sketch to extrude, and they will all be extruded i ```kcl extrude( - sketches: [[Sketch]](/docs/kcl/types/std-types-Sketch), - length: [number](/docs/kcl/types/std-types-number), - symmetric?: [bool](/docs/kcl/types/std-types-bool), - bidirectionalLength?: [number](/docs/kcl/types/std-types-number), - tagStart?: [TagDeclarator](/docs/kcl/types#TagDeclarator), - tagEnd?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [[Solid]](/docs/kcl/types/std-types-Solid) + sketches: [Sketch], + length: number, + symmetric?: bool, + bidirectionalLength?: number, + tagStart?: TagDeclarator, + tagEnd?: TagDeclarator, +): [Solid] ``` diff --git a/docs/kcl/functions/std-helix.md b/docs/kcl/functions/std-helix.md index 999f0c916..5b018d334 100644 --- a/docs/kcl/functions/std-helix.md +++ b/docs/kcl/functions/std-helix.md @@ -12,12 +12,12 @@ Create a helix. helix( revolutions: number(_), angleStart: number(Angle), - ccw?: [bool](/docs/kcl/types/std-types-bool), + ccw?: bool, radius?: number(Length), - axis?: [Axis3d](/docs/kcl/types/std-types-Axis3d) | [Edge](/docs/kcl/types/std-types-Edge), + axis?: Axis3d | Edge, length?: number(Length), - cylinder?: [Solid](/docs/kcl/types/std-types-Solid), -): [Helix](/docs/kcl/types/std-types-Helix) + cylinder?: Solid, +): Helix ``` diff --git a/docs/kcl/functions/std-math-abs.md b/docs/kcl/functions/std-math-abs.md index 6d775e3c3..795b87b02 100644 --- a/docs/kcl/functions/std-math-abs.md +++ b/docs/kcl/functions/std-math-abs.md @@ -9,7 +9,7 @@ Compute the absolute value of a number. ```kcl -abs(@input: [number](/docs/kcl/types/std-types-number)): [number](/docs/kcl/types/std-types-number) +abs(@input: number): number ``` diff --git a/docs/kcl/functions/std-math-ceil.md b/docs/kcl/functions/std-math-ceil.md index 43b4ef4ac..d5e0612b1 100644 --- a/docs/kcl/functions/std-math-ceil.md +++ b/docs/kcl/functions/std-math-ceil.md @@ -9,7 +9,7 @@ Compute the smallest integer greater than or equal to a number. ```kcl -ceil(@input: [number](/docs/kcl/types/std-types-number)): [number](/docs/kcl/types/std-types-number) +ceil(@input: number): number ``` diff --git a/docs/kcl/functions/std-math-floor.md b/docs/kcl/functions/std-math-floor.md index ecdfc4c21..6745622ac 100644 --- a/docs/kcl/functions/std-math-floor.md +++ b/docs/kcl/functions/std-math-floor.md @@ -9,7 +9,7 @@ Compute the largest integer less than or equal to a number. ```kcl -floor(@input: [number](/docs/kcl/types/std-types-number)): [number](/docs/kcl/types/std-types-number) +floor(@input: number): number ``` diff --git a/docs/kcl/functions/std-math-ln.md b/docs/kcl/functions/std-math-ln.md index 46d3e2439..bf5a20aaa 100644 --- a/docs/kcl/functions/std-math-ln.md +++ b/docs/kcl/functions/std-math-ln.md @@ -9,7 +9,7 @@ Compute the natural logarithm of the number. ```kcl -ln(@input: [number](/docs/kcl/types/std-types-number)): [number](/docs/kcl/types/std-types-number) +ln(@input: number): number ``` diff --git a/docs/kcl/functions/std-math-log.md b/docs/kcl/functions/std-math-log.md index 74c992843..46c25b1d4 100644 --- a/docs/kcl/functions/std-math-log.md +++ b/docs/kcl/functions/std-math-log.md @@ -12,9 +12,9 @@ and `log10` can produce more accurate results for base 10. ```kcl log( - @input: [number](/docs/kcl/types/std-types-number), + @input: number, base: number(_), -): [number](/docs/kcl/types/std-types-number) +): number ``` diff --git a/docs/kcl/functions/std-math-log10.md b/docs/kcl/functions/std-math-log10.md index e2826574c..a7be136a2 100644 --- a/docs/kcl/functions/std-math-log10.md +++ b/docs/kcl/functions/std-math-log10.md @@ -9,7 +9,7 @@ Compute the base 10 logarithm of the number. ```kcl -log10(@input: [number](/docs/kcl/types/std-types-number)): [number](/docs/kcl/types/std-types-number) +log10(@input: number): number ``` diff --git a/docs/kcl/functions/std-math-log2.md b/docs/kcl/functions/std-math-log2.md index 2f179350d..c607e63cf 100644 --- a/docs/kcl/functions/std-math-log2.md +++ b/docs/kcl/functions/std-math-log2.md @@ -9,7 +9,7 @@ Compute the base 2 logarithm of the number. ```kcl -log2(@input: [number](/docs/kcl/types/std-types-number)): [number](/docs/kcl/types/std-types-number) +log2(@input: number): number ``` diff --git a/docs/kcl/functions/std-math-max.md b/docs/kcl/functions/std-math-max.md index 76e069a29..891c68ec4 100644 --- a/docs/kcl/functions/std-math-max.md +++ b/docs/kcl/functions/std-math-max.md @@ -9,7 +9,7 @@ Compute the maximum of the given arguments. ```kcl -max(@input: [[number; 1+]](/docs/kcl/types/std-types-number)): [number](/docs/kcl/types/std-types-number) +max(@input: [number; 1+]): number ``` diff --git a/docs/kcl/functions/std-math-min.md b/docs/kcl/functions/std-math-min.md index ce93f428a..05222ceb0 100644 --- a/docs/kcl/functions/std-math-min.md +++ b/docs/kcl/functions/std-math-min.md @@ -9,7 +9,7 @@ Compute the minimum of the given arguments. ```kcl -min(@input: [[number; 1+]](/docs/kcl/types/std-types-number)): [number](/docs/kcl/types/std-types-number) +min(@input: [number; 1+]): number ``` diff --git a/docs/kcl/functions/std-math-polar.md b/docs/kcl/functions/std-math-polar.md index 35e157e41..190839a08 100644 --- a/docs/kcl/functions/std-math-polar.md +++ b/docs/kcl/functions/std-math-polar.md @@ -13,7 +13,7 @@ cartesian (x/y/z grid) coordinates. polar( angle: number(rad), length: number(Length), -): [Point2d](/docs/kcl/types/std-types-Point2d) +): Point2d ``` diff --git a/docs/kcl/functions/std-math-pow.md b/docs/kcl/functions/std-math-pow.md index 994bdbc93..165fef823 100644 --- a/docs/kcl/functions/std-math-pow.md +++ b/docs/kcl/functions/std-math-pow.md @@ -10,9 +10,9 @@ Compute the number to a power. ```kcl pow( - @input: [number](/docs/kcl/types/std-types-number), + @input: number, exp: number(_), -): [number](/docs/kcl/types/std-types-number) +): number ``` diff --git a/docs/kcl/functions/std-math-rem.md b/docs/kcl/functions/std-math-rem.md index ecb8b78d9..aa1a5ad2f 100644 --- a/docs/kcl/functions/std-math-rem.md +++ b/docs/kcl/functions/std-math-rem.md @@ -11,9 +11,9 @@ If `num` is negative, the result will be too. ```kcl rem( - @num: [number](/docs/kcl/types/std-types-number), - divisor: [number](/docs/kcl/types/std-types-number), -): [number](/docs/kcl/types/std-types-number) + @num: number, + divisor: number, +): number ``` diff --git a/docs/kcl/functions/std-math-round.md b/docs/kcl/functions/std-math-round.md index 0ede67710..9d643595b 100644 --- a/docs/kcl/functions/std-math-round.md +++ b/docs/kcl/functions/std-math-round.md @@ -9,7 +9,7 @@ Round a number to the nearest integer. ```kcl -round(@input: [number](/docs/kcl/types/std-types-number)): [number](/docs/kcl/types/std-types-number) +round(@input: number): number ``` diff --git a/docs/kcl/functions/std-math-sqrt.md b/docs/kcl/functions/std-math-sqrt.md index dfef051e8..945a7689f 100644 --- a/docs/kcl/functions/std-math-sqrt.md +++ b/docs/kcl/functions/std-math-sqrt.md @@ -9,7 +9,7 @@ Compute the square root of a number. ```kcl -sqrt(@input: [number](/docs/kcl/types/std-types-number)): [number](/docs/kcl/types/std-types-number) +sqrt(@input: number): number ``` diff --git a/docs/kcl/functions/std-offsetPlane.md b/docs/kcl/functions/std-offsetPlane.md index 9d25a9212..40b4fda23 100644 --- a/docs/kcl/functions/std-offsetPlane.md +++ b/docs/kcl/functions/std-offsetPlane.md @@ -11,9 +11,9 @@ plane and 10 units away from it. ```kcl offsetPlane( - @plane: [Plane](/docs/kcl/types/std-types-Plane), + @plane: Plane, offset: number(Length), -): [Plane](/docs/kcl/types/std-types-Plane) +): Plane ``` diff --git a/docs/kcl/functions/std-revolve.md b/docs/kcl/functions/std-revolve.md index 6b6c4aef9..53990f087 100644 --- a/docs/kcl/functions/std-revolve.md +++ b/docs/kcl/functions/std-revolve.md @@ -19,15 +19,15 @@ revolved around the same axis. ```kcl revolve( - @sketches: [[Sketch; 1+]](/docs/kcl/types/std-types-Sketch), - axis: [Axis2d](/docs/kcl/types/std-types-Axis2d) | [Edge](/docs/kcl/types/std-types-Edge), + @sketches: [Sketch; 1+], + axis: Axis2d | Edge, angle?: number(Angle), tolerance?: number(Length), - symmetric?: [bool](/docs/kcl/types/std-types-bool), + symmetric?: bool, bidirectionalAngle?: number(Angle), - tagStart?: [tag](/docs/kcl/types/std-types-tag), - tagEnd?: [tag](/docs/kcl/types/std-types-tag), -): [Solid](/docs/kcl/types/std-types-Solid) + tagStart?: tag, + tagEnd?: tag, +): Solid ``` diff --git a/docs/kcl/functions/std-sketch-circle.md b/docs/kcl/functions/std-sketch-circle.md index 00166321a..3b62f4f2f 100644 --- a/docs/kcl/functions/std-sketch-circle.md +++ b/docs/kcl/functions/std-sketch-circle.md @@ -11,11 +11,11 @@ the provided (x, y) origin point. ```kcl circle( - @sketch_or_surface: [Sketch](/docs/kcl/types/std-types-Sketch) | [Plane](/docs/kcl/types/std-types-Plane) | [Face](/docs/kcl/types/std-types-Face), - center: [Point2d](/docs/kcl/types/std-types-Point2d), + @sketch_or_surface: Sketch | Plane | Face, + center: Point2d, radius: number(Length), - tag?: [tag](/docs/kcl/types/std-types-tag), -): [Sketch](/docs/kcl/types/std-types-Sketch) + tag?: tag, +): Sketch ``` diff --git a/docs/kcl/functions/std-sketch-mirror2d.md b/docs/kcl/functions/std-sketch-mirror2d.md index 905570586..fa4b9e23a 100644 --- a/docs/kcl/functions/std-sketch-mirror2d.md +++ b/docs/kcl/functions/std-sketch-mirror2d.md @@ -12,9 +12,9 @@ Mirror occurs around a local sketch axis rather than a global axis. ```kcl mirror2d( - @sketches: [[Sketch; 1+]](/docs/kcl/types/std-types-Sketch), - axis: [Axis2d](/docs/kcl/types/std-types-Axis2d) | [Edge](/docs/kcl/types/std-types-Edge), -): [Sketch](/docs/kcl/types/std-types-Sketch) + @sketches: [Sketch; 1+], + axis: Axis2d | Edge, +): Sketch ``` diff --git a/docs/kcl/functions/std-solid-chamfer.md b/docs/kcl/functions/std-solid-chamfer.md index efbe045be..087d3ae4e 100644 --- a/docs/kcl/functions/std-solid-chamfer.md +++ b/docs/kcl/functions/std-solid-chamfer.md @@ -12,11 +12,11 @@ a sharp, straight transitional edge. ```kcl chamfer( - @solid: [Solid](/docs/kcl/types/std-types-Solid), + @solid: Solid, length: number(Length), - tags: [[Edge; 1+]](/docs/kcl/types/std-types-Edge), - tag?: [tag](/docs/kcl/types/std-types-tag), -): [Solid](/docs/kcl/types/std-types-Solid) + tags: [Edge; 1+], + tag?: tag, +): Solid ``` diff --git a/docs/kcl/functions/std-solid-fillet.md b/docs/kcl/functions/std-solid-fillet.md index fea89b8d3..bfa7bb36d 100644 --- a/docs/kcl/functions/std-solid-fillet.md +++ b/docs/kcl/functions/std-solid-fillet.md @@ -12,12 +12,12 @@ will smoothly blend the transition. ```kcl fillet( - @solid: [Solid](/docs/kcl/types/std-types-Solid), + @solid: Solid, radius: number(Length), - tags: [[Edge; 1+]](/docs/kcl/types/std-types-Edge), + tags: [Edge; 1+], tolerance?: number(Length), - tag?: [tag](/docs/kcl/types/std-types-tag), -): [Solid](/docs/kcl/types/std-types-Solid) + tag?: tag, +): Solid ``` diff --git a/docs/kcl/functions/std-solid-hollow.md b/docs/kcl/functions/std-solid-hollow.md index 7f6f954e4..bcaba01aa 100644 --- a/docs/kcl/functions/std-solid-hollow.md +++ b/docs/kcl/functions/std-solid-hollow.md @@ -11,9 +11,9 @@ provided thickness remains around the exterior of the shape. ```kcl hollow( - @solid: [Solid](/docs/kcl/types/std-types-Solid), + @solid: Solid, thickness: number(Length), -): [Solid](/docs/kcl/types/std-types-Solid) +): Solid ``` diff --git a/docs/kcl/functions/std-solid-shell.md b/docs/kcl/functions/std-solid-shell.md index f27c9dadf..2f119ced7 100644 --- a/docs/kcl/functions/std-solid-shell.md +++ b/docs/kcl/functions/std-solid-shell.md @@ -11,10 +11,10 @@ provided thickness remains, taking volume starting at the providedface, leaving ```kcl shell( - @solids: [[Solid; 1+]](/docs/kcl/types/std-types-Solid), + @solids: [Solid; 1+], thickness: number(Length), - faces: [[tag; 1+]](/docs/kcl/types/std-types-tag), -): [[Solid]](/docs/kcl/types/std-types-Solid) + faces: [tag; 1+], +): [Solid] ``` diff --git a/docs/kcl/getCommonEdge.md b/docs/kcl/getCommonEdge.md index d24c7a9f6..32b65ab72 100644 --- a/docs/kcl/getCommonEdge.md +++ b/docs/kcl/getCommonEdge.md @@ -9,7 +9,7 @@ Get the shared edge between two faces. ```kcl -getCommonEdge(faces: [[TagIdentifier]](/docs/kcl/types#TagIdentifier)): Uuid +getCommonEdge(faces: [TagIdentifier]): Uuid ``` diff --git a/docs/kcl/getNextAdjacentEdge.md b/docs/kcl/getNextAdjacentEdge.md index 5486828d1..1619bde57 100644 --- a/docs/kcl/getNextAdjacentEdge.md +++ b/docs/kcl/getNextAdjacentEdge.md @@ -9,7 +9,7 @@ Get the next adjacent edge to the edge given. ```kcl -getNextAdjacentEdge(edge: [TagIdentifier](/docs/kcl/types#TagIdentifier)): Uuid +getNextAdjacentEdge(edge: TagIdentifier): Uuid ``` diff --git a/docs/kcl/getOppositeEdge.md b/docs/kcl/getOppositeEdge.md index 47742ed3c..430e56cd8 100644 --- a/docs/kcl/getOppositeEdge.md +++ b/docs/kcl/getOppositeEdge.md @@ -9,7 +9,7 @@ Get the opposite edge to the edge given. ```kcl -getOppositeEdge(edge: [TagIdentifier](/docs/kcl/types#TagIdentifier)): Uuid +getOppositeEdge(edge: TagIdentifier): Uuid ``` diff --git a/docs/kcl/getPreviousAdjacentEdge.md b/docs/kcl/getPreviousAdjacentEdge.md index 31c0ca714..75fe03a09 100644 --- a/docs/kcl/getPreviousAdjacentEdge.md +++ b/docs/kcl/getPreviousAdjacentEdge.md @@ -9,7 +9,7 @@ Get the previous adjacent edge to the edge given. ```kcl -getPreviousAdjacentEdge(edge: [TagIdentifier](/docs/kcl/types#TagIdentifier)): Uuid +getPreviousAdjacentEdge(edge: TagIdentifier): Uuid ``` diff --git a/docs/kcl/intersect.md b/docs/kcl/intersect.md index 392f0a022..22da99281 100644 --- a/docs/kcl/intersect.md +++ b/docs/kcl/intersect.md @@ -10,9 +10,9 @@ Intersect computes the geometric intersection of multiple solid bodies, returnin ```kcl intersect( - solids: [[Solid]](/docs/kcl/types/std-types-Solid), - tolerance?: [number](/docs/kcl/types/std-types-number), -): [[Solid]](/docs/kcl/types/std-types-Solid) + solids: [Solid], + tolerance?: number, +): [Solid] ``` diff --git a/docs/kcl/involuteCircular.md b/docs/kcl/involuteCircular.md index c8d790cbe..cd0c1a27e 100644 --- a/docs/kcl/involuteCircular.md +++ b/docs/kcl/involuteCircular.md @@ -10,13 +10,13 @@ Extend the current sketch with a new involute circular curve. ```kcl involuteCircular( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - startRadius: [number](/docs/kcl/types/std-types-number), - endRadius: [number](/docs/kcl/types/std-types-number), - angle: [number](/docs/kcl/types/std-types-number), - reverse?: [bool](/docs/kcl/types/std-types-bool), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + startRadius: number, + endRadius: number, + angle: number, + reverse?: bool, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/lastSegX.md b/docs/kcl/lastSegX.md index 9c3a498d9..db5c4a4b4 100644 --- a/docs/kcl/lastSegX.md +++ b/docs/kcl/lastSegX.md @@ -9,7 +9,7 @@ Extract the 'x' axis value of the last line segment in the provided 2-d sketch. ```kcl -lastSegX(sketch: [Sketch](/docs/kcl/types/std-types-Sketch)): [number](/docs/kcl/types/std-types-number) +lastSegX(sketch: Sketch): number ``` diff --git a/docs/kcl/lastSegY.md b/docs/kcl/lastSegY.md index 6c6e72be6..638df839d 100644 --- a/docs/kcl/lastSegY.md +++ b/docs/kcl/lastSegY.md @@ -9,7 +9,7 @@ Extract the 'y' axis value of the last line segment in the provided 2-d sketch. ```kcl -lastSegY(sketch: [Sketch](/docs/kcl/types/std-types-Sketch)): [number](/docs/kcl/types/std-types-number) +lastSegY(sketch: Sketch): number ``` diff --git a/docs/kcl/legAngX.md b/docs/kcl/legAngX.md index 6dce39464..b0134682e 100644 --- a/docs/kcl/legAngX.md +++ b/docs/kcl/legAngX.md @@ -10,9 +10,9 @@ Compute the angle of the given leg for x. ```kcl legAngX( - hypotenuse: [number](/docs/kcl/types/std-types-number), - leg: [number](/docs/kcl/types/std-types-number), -): [number](/docs/kcl/types/std-types-number) + hypotenuse: number, + leg: number, +): number ``` ### Tags diff --git a/docs/kcl/legAngY.md b/docs/kcl/legAngY.md index 2a5279073..7ecd6ea3b 100644 --- a/docs/kcl/legAngY.md +++ b/docs/kcl/legAngY.md @@ -10,9 +10,9 @@ Compute the angle of the given leg for y. ```kcl legAngY( - hypotenuse: [number](/docs/kcl/types/std-types-number), - leg: [number](/docs/kcl/types/std-types-number), -): [number](/docs/kcl/types/std-types-number) + hypotenuse: number, + leg: number, +): number ``` ### Tags diff --git a/docs/kcl/legLen.md b/docs/kcl/legLen.md index 7938bc70c..9fc976ef7 100644 --- a/docs/kcl/legLen.md +++ b/docs/kcl/legLen.md @@ -10,9 +10,9 @@ Compute the length of the given leg. ```kcl legLen( - hypotenuse: [number](/docs/kcl/types/std-types-number), - leg: [number](/docs/kcl/types/std-types-number), -): [number](/docs/kcl/types/std-types-number) + hypotenuse: number, + leg: number, +): number ``` ### Tags diff --git a/docs/kcl/line.md b/docs/kcl/line.md index 1f02c6cb5..768f50940 100644 --- a/docs/kcl/line.md +++ b/docs/kcl/line.md @@ -10,11 +10,11 @@ Extend the current sketch with a new straight line. ```kcl line( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - endAbsolute?: [Point2d](/docs/kcl/types/std-types-Point2d), - end?: [Point2d](/docs/kcl/types/std-types-Point2d), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + endAbsolute?: Point2d, + end?: Point2d, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/loft.md b/docs/kcl/loft.md index 74ce1460c..5e9619237 100644 --- a/docs/kcl/loft.md +++ b/docs/kcl/loft.md @@ -10,14 +10,14 @@ The sketches need to closed and on the same plane. ```kcl loft( - sketches: [[Sketch]](/docs/kcl/types/std-types-Sketch), - vDegree: [number](/docs/kcl/types/std-types-number), - bezApproximateRational: [bool](/docs/kcl/types/std-types-bool), - baseCurveIndex?: [number](/docs/kcl/types/std-types-number), - tolerance?: [number](/docs/kcl/types/std-types-number), - tagStart?: [TagDeclarator](/docs/kcl/types#TagDeclarator), - tagEnd?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Solid](/docs/kcl/types/std-types-Solid) + sketches: [Sketch], + vDegree: number, + bezApproximateRational: bool, + baseCurveIndex?: number, + tolerance?: number, + tagStart?: TagDeclarator, + tagEnd?: TagDeclarator, +): Solid ``` diff --git a/docs/kcl/map.md b/docs/kcl/map.md index 2e80ced19..490420335 100644 --- a/docs/kcl/map.md +++ b/docs/kcl/map.md @@ -6,13 +6,13 @@ layout: manual Apply a function to every element of a list. -Given a list like `[[a, b, c]]`, and a function like `f`, returns `[[f(a), f(b), f(c)]]` +Given a list like `[a, b, c]`, and a function like `f`, returns `[f(a), f(b), f(c)]` ```kcl map( - array: [[any]](/docs/kcl/types/std-types-any), + array: [any], f: FunctionSource, -): [[any]](/docs/kcl/types/std-types-any) +): [any] ``` diff --git a/docs/kcl/patternCircular2d.md b/docs/kcl/patternCircular2d.md index 228b64b94..00eaf2ea3 100644 --- a/docs/kcl/patternCircular2d.md +++ b/docs/kcl/patternCircular2d.md @@ -10,13 +10,13 @@ Repeat a 2-dimensional sketch some number of times along a partial or complete c ```kcl patternCircular2d( - sketchSet: [[Sketch]](/docs/kcl/types/std-types-Sketch), - instances: [number](/docs/kcl/types/std-types-number), - center: [Point2d](/docs/kcl/types/std-types-Point2d), - arcDegrees: [number](/docs/kcl/types/std-types-number), - rotateDuplicates: [bool](/docs/kcl/types/std-types-bool), - useOriginal?: [bool](/docs/kcl/types/std-types-bool), -): [[Sketch]](/docs/kcl/types/std-types-Sketch) + sketchSet: [Sketch], + instances: number, + center: Point2d, + arcDegrees: number, + rotateDuplicates: bool, + useOriginal?: bool, +): [Sketch] ``` diff --git a/docs/kcl/patternCircular3d.md b/docs/kcl/patternCircular3d.md index 1c4e5ba45..0276595e7 100644 --- a/docs/kcl/patternCircular3d.md +++ b/docs/kcl/patternCircular3d.md @@ -10,14 +10,14 @@ Repeat a 3-dimensional solid some number of times along a partial or complete ci ```kcl patternCircular3d( - solids: [[Solid]](/docs/kcl/types/std-types-Solid), - instances: [number](/docs/kcl/types/std-types-number), - axis: [[number]](/docs/kcl/types/std-types-number), - center: [Point3d](/docs/kcl/types/std-types-Point3d), - arcDegrees: [number](/docs/kcl/types/std-types-number), - rotateDuplicates: [bool](/docs/kcl/types/std-types-bool), - useOriginal?: [bool](/docs/kcl/types/std-types-bool), -): [[Solid]](/docs/kcl/types/std-types-Solid) + solids: [Solid], + instances: number, + axis: [number], + center: Point3d, + arcDegrees: number, + rotateDuplicates: bool, + useOriginal?: bool, +): [Solid] ``` diff --git a/docs/kcl/patternLinear2d.md b/docs/kcl/patternLinear2d.md index 44e8030b6..5a8916700 100644 --- a/docs/kcl/patternLinear2d.md +++ b/docs/kcl/patternLinear2d.md @@ -10,12 +10,12 @@ Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of dis ```kcl patternLinear2d( - sketches: [[Sketch]](/docs/kcl/types/std-types-Sketch), - instances: [number](/docs/kcl/types/std-types-number), - distance: [number](/docs/kcl/types/std-types-number), - axis: [Point2d](/docs/kcl/types/std-types-Point2d), - useOriginal?: [bool](/docs/kcl/types/std-types-bool), -): [[Sketch]](/docs/kcl/types/std-types-Sketch) + sketches: [Sketch], + instances: number, + distance: number, + axis: Point2d, + useOriginal?: bool, +): [Sketch] ``` diff --git a/docs/kcl/patternLinear3d.md b/docs/kcl/patternLinear3d.md index c8c3598a7..6aca53d0f 100644 --- a/docs/kcl/patternLinear3d.md +++ b/docs/kcl/patternLinear3d.md @@ -10,12 +10,12 @@ Repeat a 3-dimensional solid along a linear path, with a dynamic amount of dista ```kcl patternLinear3d( - solids: [[Solid]](/docs/kcl/types/std-types-Solid), - instances: [number](/docs/kcl/types/std-types-number), - distance: [number](/docs/kcl/types/std-types-number), - axis: [Point3d](/docs/kcl/types/std-types-Point3d), - useOriginal?: [bool](/docs/kcl/types/std-types-bool), -): [[Solid]](/docs/kcl/types/std-types-Solid) + solids: [Solid], + instances: number, + distance: number, + axis: Point3d, + useOriginal?: bool, +): [Solid] ``` diff --git a/docs/kcl/patternTransform.md b/docs/kcl/patternTransform.md index cb29978a8..7702b50a7 100644 --- a/docs/kcl/patternTransform.md +++ b/docs/kcl/patternTransform.md @@ -36,11 +36,11 @@ The transform function returns a transform object. All properties of the object ```kcl patternTransform( - solids: [[Solid]](/docs/kcl/types/std-types-Solid), - instances: [number](/docs/kcl/types/std-types-number), + solids: [Solid], + instances: number, transform: FunctionSource, - useOriginal?: [bool](/docs/kcl/types/std-types-bool), -): [[Solid]](/docs/kcl/types/std-types-Solid) + useOriginal?: bool, +): [Solid] ``` diff --git a/docs/kcl/patternTransform2d.md b/docs/kcl/patternTransform2d.md index 186c4d57a..87e03a22d 100644 --- a/docs/kcl/patternTransform2d.md +++ b/docs/kcl/patternTransform2d.md @@ -10,11 +10,11 @@ Just like patternTransform, but works on 2D sketches not 3D solids. ```kcl patternTransform2d( - sketches: [[Sketch]](/docs/kcl/types/std-types-Sketch), - instances: [number](/docs/kcl/types/std-types-number), + sketches: [Sketch], + instances: number, transform: FunctionSource, - useOriginal?: [bool](/docs/kcl/types/std-types-bool), -): [[Sketch]](/docs/kcl/types/std-types-Sketch) + useOriginal?: bool, +): [Sketch] ``` diff --git a/docs/kcl/polygon.md b/docs/kcl/polygon.md index ebdc19289..c2fd2d04a 100644 --- a/docs/kcl/polygon.md +++ b/docs/kcl/polygon.md @@ -10,12 +10,12 @@ Create a regular polygon with the specified number of sides that is either inscr ```kcl polygon( - sketchSurfaceOrGroup: [Sketch](/docs/kcl/types/std-types-Sketch) | [Plane](/docs/kcl/types/std-types-Plane) | [Face](/docs/kcl/types/std-types-Face), - radius: [number](/docs/kcl/types/std-types-number), + sketchSurfaceOrGroup: Sketch | Plane | Face, + radius: number, numSides: u64, - center: [Point2d](/docs/kcl/types/std-types-Point2d), - inscribed?: [bool](/docs/kcl/types/std-types-bool), -): [Sketch](/docs/kcl/types/std-types-Sketch) + center: Point2d, + inscribed?: bool, +): Sketch ``` diff --git a/docs/kcl/pop.md b/docs/kcl/pop.md index 289d401f0..184bf1d39 100644 --- a/docs/kcl/pop.md +++ b/docs/kcl/pop.md @@ -9,7 +9,7 @@ Remove the last element from an array. Returns a new array with the last element removed. ```kcl -pop(array: [[any]](/docs/kcl/types/std-types-any)): [any](/docs/kcl/types/std-types-any) +pop(array: [any]): any ``` diff --git a/docs/kcl/profileStart.md b/docs/kcl/profileStart.md index 049513689..997d951c8 100644 --- a/docs/kcl/profileStart.md +++ b/docs/kcl/profileStart.md @@ -9,7 +9,7 @@ Extract the provided 2-dimensional sketch's profile's origin value. ```kcl -profileStart(profile: [Sketch](/docs/kcl/types/std-types-Sketch)): [[number]](/docs/kcl/types/std-types-number) +profileStart(profile: Sketch): [number] ``` diff --git a/docs/kcl/profileStartX.md b/docs/kcl/profileStartX.md index 104ed31ea..dcff89a53 100644 --- a/docs/kcl/profileStartX.md +++ b/docs/kcl/profileStartX.md @@ -9,7 +9,7 @@ Extract the provided 2-dimensional sketch's profile's origin's 'x' value. ```kcl -profileStartX(profile: [Sketch](/docs/kcl/types/std-types-Sketch)): [number](/docs/kcl/types/std-types-number) +profileStartX(profile: Sketch): number ``` diff --git a/docs/kcl/profileStartY.md b/docs/kcl/profileStartY.md index b3cde12f6..7c02b8243 100644 --- a/docs/kcl/profileStartY.md +++ b/docs/kcl/profileStartY.md @@ -9,7 +9,7 @@ Extract the provided 2-dimensional sketch's profile's origin's 'y' value. ```kcl -profileStartY(profile: [Sketch](/docs/kcl/types/std-types-Sketch)): [number](/docs/kcl/types/std-types-number) +profileStartY(profile: Sketch): number ``` diff --git a/docs/kcl/push.md b/docs/kcl/push.md index bc91896b6..19a1c64e0 100644 --- a/docs/kcl/push.md +++ b/docs/kcl/push.md @@ -10,9 +10,9 @@ Returns a new array with the element appended. ```kcl push( - array: [[any]](/docs/kcl/types/std-types-any), - item: [any](/docs/kcl/types/std-types-any), -): [any](/docs/kcl/types/std-types-any) + array: [any], + item: any, +): any ``` diff --git a/docs/kcl/reduce.md b/docs/kcl/reduce.md index b9b5078f2..b7dd42e1e 100644 --- a/docs/kcl/reduce.md +++ b/docs/kcl/reduce.md @@ -10,10 +10,10 @@ Take a starting value. Then, for each element of an array, calculate the next va ```kcl reduce( - array: [[any]](/docs/kcl/types/std-types-any), - initial: [any](/docs/kcl/types/std-types-any), + array: [any], + initial: any, f: FunctionSource, -): [any](/docs/kcl/types/std-types-any) +): any ``` diff --git a/docs/kcl/rotate.md b/docs/kcl/rotate.md index 200e0fd50..e5f7be9a5 100644 --- a/docs/kcl/rotate.md +++ b/docs/kcl/rotate.md @@ -28,14 +28,14 @@ When rotating a part around an axis, you specify the axis of rotation and the an ```kcl rotate( - objects: [[Solid]](/docs/kcl/types/std-types-Solid) | [[Sketch]](/docs/kcl/types/std-types-Sketch) | [ImportedGeometry](/docs/kcl/types#ImportedGeometry), - roll?: [number](/docs/kcl/types/std-types-number), - pitch?: [number](/docs/kcl/types/std-types-number), - yaw?: [number](/docs/kcl/types/std-types-number), - axis?: [[number]](/docs/kcl/types/std-types-number), - angle?: [number](/docs/kcl/types/std-types-number), - global?: [bool](/docs/kcl/types/std-types-bool), -): [[Solid]](/docs/kcl/types/std-types-Solid) | [[Sketch]](/docs/kcl/types/std-types-Sketch) | [ImportedGeometry](/docs/kcl/types#ImportedGeometry) + objects: [Solid] | [Sketch] | ImportedGeometry, + roll?: number, + pitch?: number, + yaw?: number, + axis?: [number], + angle?: number, + global?: bool, +): [Solid] | [Sketch] | ImportedGeometry ``` diff --git a/docs/kcl/scale.md b/docs/kcl/scale.md index f4cce07b8..901a7424a 100644 --- a/docs/kcl/scale.md +++ b/docs/kcl/scale.md @@ -16,12 +16,12 @@ If you want to apply the transform in global space, set `global` to `true`. The ```kcl scale( - objects: [[Solid]](/docs/kcl/types/std-types-Solid) | [[Sketch]](/docs/kcl/types/std-types-Sketch) | [ImportedGeometry](/docs/kcl/types#ImportedGeometry), - x?: [number](/docs/kcl/types/std-types-number), - y?: [number](/docs/kcl/types/std-types-number), - z?: [number](/docs/kcl/types/std-types-number), - global?: [bool](/docs/kcl/types/std-types-bool), -): [[Solid]](/docs/kcl/types/std-types-Solid) | [[Sketch]](/docs/kcl/types/std-types-Sketch) | [ImportedGeometry](/docs/kcl/types#ImportedGeometry) + objects: [Solid] | [Sketch] | ImportedGeometry, + x?: number, + y?: number, + z?: number, + global?: bool, +): [Solid] | [Sketch] | ImportedGeometry ``` diff --git a/docs/kcl/segAng.md b/docs/kcl/segAng.md index c98e541b1..e9aef8b9b 100644 --- a/docs/kcl/segAng.md +++ b/docs/kcl/segAng.md @@ -9,7 +9,7 @@ Compute the angle (in degrees) of the provided line segment. ```kcl -segAng(tag: [TagIdentifier](/docs/kcl/types#TagIdentifier)): [number](/docs/kcl/types/std-types-number) +segAng(tag: TagIdentifier): number ``` diff --git a/docs/kcl/segEnd.md b/docs/kcl/segEnd.md index 8331d7b6f..29323fccd 100644 --- a/docs/kcl/segEnd.md +++ b/docs/kcl/segEnd.md @@ -9,7 +9,7 @@ Compute the ending point of the provided line segment. ```kcl -segEnd(tag: [TagIdentifier](/docs/kcl/types#TagIdentifier)): [Point2d](/docs/kcl/types/std-types-Point2d) +segEnd(tag: TagIdentifier): Point2d ``` diff --git a/docs/kcl/segEndX.md b/docs/kcl/segEndX.md index 95a5d7cf0..c150680dd 100644 --- a/docs/kcl/segEndX.md +++ b/docs/kcl/segEndX.md @@ -9,7 +9,7 @@ Compute the ending point of the provided line segment along the 'x' axis. ```kcl -segEndX(tag: [TagIdentifier](/docs/kcl/types#TagIdentifier)): [number](/docs/kcl/types/std-types-number) +segEndX(tag: TagIdentifier): number ``` diff --git a/docs/kcl/segEndY.md b/docs/kcl/segEndY.md index 76e42c185..14b828d93 100644 --- a/docs/kcl/segEndY.md +++ b/docs/kcl/segEndY.md @@ -9,7 +9,7 @@ Compute the ending point of the provided line segment along the 'y' axis. ```kcl -segEndY(tag: [TagIdentifier](/docs/kcl/types#TagIdentifier)): [number](/docs/kcl/types/std-types-number) +segEndY(tag: TagIdentifier): number ``` diff --git a/docs/kcl/segLen.md b/docs/kcl/segLen.md index abc7d5e73..da9fcb62a 100644 --- a/docs/kcl/segLen.md +++ b/docs/kcl/segLen.md @@ -9,7 +9,7 @@ Compute the length of the provided line segment. ```kcl -segLen(tag: [TagIdentifier](/docs/kcl/types#TagIdentifier)): [number](/docs/kcl/types/std-types-number) +segLen(tag: TagIdentifier): number ``` diff --git a/docs/kcl/segStart.md b/docs/kcl/segStart.md index 371584745..86e1e50d5 100644 --- a/docs/kcl/segStart.md +++ b/docs/kcl/segStart.md @@ -9,7 +9,7 @@ Compute the starting point of the provided line segment. ```kcl -segStart(tag: [TagIdentifier](/docs/kcl/types#TagIdentifier)): [Point2d](/docs/kcl/types/std-types-Point2d) +segStart(tag: TagIdentifier): Point2d ``` diff --git a/docs/kcl/segStartX.md b/docs/kcl/segStartX.md index c9ac34019..ccc7ff055 100644 --- a/docs/kcl/segStartX.md +++ b/docs/kcl/segStartX.md @@ -9,7 +9,7 @@ Compute the starting point of the provided line segment along the 'x' axis. ```kcl -segStartX(tag: [TagIdentifier](/docs/kcl/types#TagIdentifier)): [number](/docs/kcl/types/std-types-number) +segStartX(tag: TagIdentifier): number ``` diff --git a/docs/kcl/segStartY.md b/docs/kcl/segStartY.md index dc78c0a80..7cf9b259f 100644 --- a/docs/kcl/segStartY.md +++ b/docs/kcl/segStartY.md @@ -9,7 +9,7 @@ Compute the starting point of the provided line segment along the 'y' axis. ```kcl -segStartY(tag: [TagIdentifier](/docs/kcl/types#TagIdentifier)): [number](/docs/kcl/types/std-types-number) +segStartY(tag: TagIdentifier): number ``` diff --git a/docs/kcl/startProfile.md b/docs/kcl/startProfile.md index 34990b8c5..41fb9074e 100644 --- a/docs/kcl/startProfile.md +++ b/docs/kcl/startProfile.md @@ -10,10 +10,10 @@ Start a new profile at a given point. ```kcl startProfile( - sketchSurface: [Plane](/docs/kcl/types/std-types-Plane) | [Face](/docs/kcl/types/std-types-Face), - at: [Point2d](/docs/kcl/types/std-types-Point2d), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketchSurface: Plane | Face, + at: Point2d, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/startSketchOn.md b/docs/kcl/startSketchOn.md index 57068de97..7069fabc2 100644 --- a/docs/kcl/startSketchOn.md +++ b/docs/kcl/startSketchOn.md @@ -18,9 +18,9 @@ The point is if you want to export the result of a sketch on a face, you only ne ```kcl startSketchOn( - planeOrSolid: [Plane](/docs/kcl/types/std-types-Plane) | [Solid](/docs/kcl/types/std-types-Solid), - face?: [TagIdentifier](/docs/kcl/types#TagIdentifier) | [Start](/docs/kcl/types#Start) | [End](/docs/kcl/types#End), -): [Plane](/docs/kcl/types/std-types-Plane) | [Face](/docs/kcl/types/std-types-Face) + planeOrSolid: Plane | Solid, + face?: TagIdentifier | Start | End, +): Plane | Face ``` diff --git a/docs/kcl/subtract.md b/docs/kcl/subtract.md index 8cce930a3..e569afba5 100644 --- a/docs/kcl/subtract.md +++ b/docs/kcl/subtract.md @@ -10,10 +10,10 @@ Performs a boolean subtraction operation, removing the volume of one or more too ```kcl subtract( - solids: [[Solid]](/docs/kcl/types/std-types-Solid), - tools: [[Solid]](/docs/kcl/types/std-types-Solid), - tolerance?: [number](/docs/kcl/types/std-types-number), -): [[Solid]](/docs/kcl/types/std-types-Solid) + solids: [Solid], + tools: [Solid], + tolerance?: number, +): [Solid] ``` diff --git a/docs/kcl/subtract2d.md b/docs/kcl/subtract2d.md index 57e78dd72..aa3f33f0e 100644 --- a/docs/kcl/subtract2d.md +++ b/docs/kcl/subtract2d.md @@ -10,9 +10,9 @@ Use a 2-dimensional sketch to cut a hole in another 2-dimensional sketch. ```kcl subtract2d( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - tool: [[Sketch]](/docs/kcl/types/std-types-Sketch), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + tool: [Sketch], +): Sketch ``` diff --git a/docs/kcl/sweep.md b/docs/kcl/sweep.md index 807a0d974..dc2a9b13a 100644 --- a/docs/kcl/sweep.md +++ b/docs/kcl/sweep.md @@ -12,13 +12,13 @@ You can provide more than one sketch to sweep, and they will all be swept along ```kcl sweep( - sketches: [[Sketch]](/docs/kcl/types/std-types-Sketch), - path: [Sketch](/docs/kcl/types/std-types-Sketch) | [Helix](/docs/kcl/types/std-types-Helix), - sectional?: [bool](/docs/kcl/types/std-types-bool), - tolerance?: [number](/docs/kcl/types/std-types-number), - tagStart?: [TagDeclarator](/docs/kcl/types#TagDeclarator), - tagEnd?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [[Solid]](/docs/kcl/types/std-types-Solid) + sketches: [Sketch], + path: Sketch | Helix, + sectional?: bool, + tolerance?: number, + tagStart?: TagDeclarator, + tagEnd?: TagDeclarator, +): [Solid] ``` diff --git a/docs/kcl/tangentToEnd.md b/docs/kcl/tangentToEnd.md index c45bd7eb1..e8aa077e6 100644 --- a/docs/kcl/tangentToEnd.md +++ b/docs/kcl/tangentToEnd.md @@ -9,7 +9,7 @@ Returns the angle coming out of the end of the segment in degrees. ```kcl -tangentToEnd(tag: [TagIdentifier](/docs/kcl/types#TagIdentifier)): [number](/docs/kcl/types/std-types-number) +tangentToEnd(tag: TagIdentifier): number ``` diff --git a/docs/kcl/tangentialArc.md b/docs/kcl/tangentialArc.md index cbb12f1dc..f11113ef9 100644 --- a/docs/kcl/tangentialArc.md +++ b/docs/kcl/tangentialArc.md @@ -10,13 +10,13 @@ When using radius and angle, draw a curved line segment along part of an imagina ```kcl tangentialArc( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - endAbsolute?: [Point2d](/docs/kcl/types/std-types-Point2d), - end?: [Point2d](/docs/kcl/types/std-types-Point2d), - radius?: [number](/docs/kcl/types/std-types-number), - angle?: [number](/docs/kcl/types/std-types-number), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + endAbsolute?: Point2d, + end?: Point2d, + radius?: number, + angle?: number, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/translate.md b/docs/kcl/translate.md index 51256e4ff..870d5c69c 100644 --- a/docs/kcl/translate.md +++ b/docs/kcl/translate.md @@ -12,12 +12,12 @@ Translate is really useful for sketches if you want to move a sketch and then ro ```kcl translate( - objects: [[Solid]](/docs/kcl/types/std-types-Solid) | [[Sketch]](/docs/kcl/types/std-types-Sketch) | [ImportedGeometry](/docs/kcl/types#ImportedGeometry), - x?: [number](/docs/kcl/types/std-types-number), - y?: [number](/docs/kcl/types/std-types-number), - z?: [number](/docs/kcl/types/std-types-number), - global?: [bool](/docs/kcl/types/std-types-bool), -): [[Solid]](/docs/kcl/types/std-types-Solid) | [[Sketch]](/docs/kcl/types/std-types-Sketch) | [ImportedGeometry](/docs/kcl/types#ImportedGeometry) + objects: [Solid] | [Sketch] | ImportedGeometry, + x?: number, + y?: number, + z?: number, + global?: bool, +): [Solid] | [Sketch] | ImportedGeometry ``` diff --git a/docs/kcl/types/std-types-Point2d.md b/docs/kcl/types/std-types-Point2d.md index 6f79b16c9..ebeb4a3dc 100644 --- a/docs/kcl/types/std-types-Point2d.md +++ b/docs/kcl/types/std-types-Point2d.md @@ -11,7 +11,7 @@ type Point2d = [number(Length); 2] ``` [`Point2d`](/docs/kcl/types/std-types-Point2d) is an alias for a two-element array of [number](/docs/kcl/types/number)s. To write a value -with type [`Point2d`](/docs/kcl/types/std-types-Point2d), use an array, e.g., `[[0, 0]]` or `[[5.0, 3.14]]`. +with type [`Point2d`](/docs/kcl/types/std-types-Point2d), use an array, e.g., `[0, 0]` or `[5.0, 3.14]`. diff --git a/docs/kcl/types/std-types-Point3d.md b/docs/kcl/types/std-types-Point3d.md index 98a8a92be..ea23e7c86 100644 --- a/docs/kcl/types/std-types-Point3d.md +++ b/docs/kcl/types/std-types-Point3d.md @@ -11,7 +11,7 @@ type Point3d = [number(Length); 3] ``` [`Point3d`](/docs/kcl/types/std-types-Point3d) is an alias for a three-element array of [number](/docs/kcl/types/number)s. To write a value -with type [`Point3d`](/docs/kcl/types/std-types-Point3d), use an array, e.g., `[[0, 0, 0]]` or `[[5.0, 3.14, 6.8]]`. +with type [`Point3d`](/docs/kcl/types/std-types-Point3d), use an array, e.g., `[0, 0, 0]` or `[5.0, 3.14, 6.8]`. diff --git a/docs/kcl/union.md b/docs/kcl/union.md index 9a84c9261..85920bc9d 100644 --- a/docs/kcl/union.md +++ b/docs/kcl/union.md @@ -10,9 +10,9 @@ Union two or more solids into a single solid. ```kcl union( - solids: [[Solid]](/docs/kcl/types/std-types-Solid), - tolerance?: [number](/docs/kcl/types/std-types-number), -): [[Solid]](/docs/kcl/types/std-types-Solid) + solids: [Solid], + tolerance?: number, +): [Solid] ``` diff --git a/docs/kcl/xLine.md b/docs/kcl/xLine.md index 65f1c474d..e927ce01c 100644 --- a/docs/kcl/xLine.md +++ b/docs/kcl/xLine.md @@ -10,11 +10,11 @@ Draw a line relative to the current origin to a specified distance away from the ```kcl xLine( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - length?: [number](/docs/kcl/types/std-types-number), - endAbsolute?: [number](/docs/kcl/types/std-types-number), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + length?: number, + endAbsolute?: number, + tag?: TagDeclarator, +): Sketch ``` diff --git a/docs/kcl/yLine.md b/docs/kcl/yLine.md index 8a1668363..5a60f5288 100644 --- a/docs/kcl/yLine.md +++ b/docs/kcl/yLine.md @@ -10,11 +10,11 @@ Draw a line relative to the current origin to a specified distance away from the ```kcl yLine( - sketch: [Sketch](/docs/kcl/types/std-types-Sketch), - length?: [number](/docs/kcl/types/std-types-number), - endAbsolute?: [number](/docs/kcl/types/std-types-number), - tag?: [TagDeclarator](/docs/kcl/types#TagDeclarator), -): [Sketch](/docs/kcl/types/std-types-Sketch) + sketch: Sketch, + length?: number, + endAbsolute?: number, + tag?: TagDeclarator, +): Sketch ``` diff --git a/rust/kcl-lib/src/docs/gen_std_tests.rs b/rust/kcl-lib/src/docs/gen_std_tests.rs index 3f8c785ef..c0c3750e4 100644 --- a/rust/kcl-lib/src/docs/gen_std_tests.rs +++ b/rust/kcl-lib/src/docs/gen_std_tests.rs @@ -577,12 +577,16 @@ fn cleanup_type_string(input: &str, fmt_for_text: bool) -> String { ty }; - if SPECIAL_TYPES.contains(&ty) { + // TODO markdown links in code blocks are not turned into links by our website stack. + // If we can handle signatures more manually we could get highlighting and links and + // we might want to restore the links by not checking `fmt_for_text` here. + + if fmt_for_text && SPECIAL_TYPES.contains(&ty) { format!("[{prefix}{ty}{suffix}](/docs/kcl/types#{ty})") - } else if DECLARED_TYPES.contains(&ty) { + } else if fmt_for_text && DECLARED_TYPES.contains(&ty) { format!("[{prefix}{ty}{suffix}](/docs/kcl/types/std-types-{ty})") } else { - format!("{prefix}{input}{suffix}") + format!("{prefix}{ty}{suffix}") } }) .collect();