Improve hover tool tips and function docs (#5538)

* Improve hover tool tips and function docs Signed-off-by: Nick Cameron <[email protected]> * A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores) * A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores) --------- Signed-off-by: Nick Cameron <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
KittyCAD · Feb 27, 2025 · 1104d90 · 1104d90
1 parent 2efea3e
commit 1104d90
Show file tree

Hide file tree

Showing 71 changed files with 389 additions and 87 deletions.
diff --git a/docs/kcl/angleToMatchLengthX.md b/docs/kcl/angleToMatchLengthX.md
@@ -9,7 +9,11 @@ Returns the angle to match the given length for x.
 
 
 ```js
-angleToMatchLengthX(tag: TagIdentifier, to: number, sketch: Sketch) -> number
+angleToMatchLengthX(
+  tag: TagIdentifier,
+  to: number,
+  sketch: Sketch,
+) -> number
 ```
 
 

diff --git a/docs/kcl/angleToMatchLengthY.md b/docs/kcl/angleToMatchLengthY.md
@@ -9,7 +9,11 @@ Returns the angle to match the given length for y.
 
 
 ```js
-angleToMatchLengthY(tag: TagIdentifier, to: number, sketch: Sketch) -> number
+angleToMatchLengthY(
+  tag: TagIdentifier,
+  to: number,
+  sketch: Sketch,
+) -> number
 ```
 
 

diff --git a/docs/kcl/angledLine.md b/docs/kcl/angledLine.md
@@ -9,7 +9,11 @@ Draw a line segment relative to the current origin using the polar
 measure of some angle and distance.
 
 ```js
-angledLine(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLine(
+  data: AngledLineData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/angledLineOfXLength.md b/docs/kcl/angledLineOfXLength.md
@@ -9,7 +9,11 @@ Create a line segment from the current 2-dimensional sketch origin
 along some angle (in degrees) for some relative length in the 'x' dimension.
 
 ```js
-angledLineOfXLength(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineOfXLength(
+  data: AngledLineData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/angledLineOfYLength.md b/docs/kcl/angledLineOfYLength.md
@@ -9,7 +9,11 @@ Create a line segment from the current 2-dimensional sketch origin
 along some angle (in degrees) for some relative length in the 'y' dimension.
 
 ```js
-angledLineOfYLength(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineOfYLength(
+  data: AngledLineData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/angledLineThatIntersects.md b/docs/kcl/angledLineThatIntersects.md
@@ -9,7 +9,11 @@ Draw an angled line from the current origin, constructing a line segment
 such that the newly created line intersects the desired target line segment.
 
 ```js
-angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineThatIntersects(
+  data: AngledLineThatIntersectsData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/angledLineToX.md b/docs/kcl/angledLineToX.md
@@ -9,7 +9,11 @@ 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.
 
 ```js
-angledLineToX(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineToX(
+  data: AngledLineToData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/angledLineToY.md b/docs/kcl/angledLineToY.md
@@ -9,7 +9,11 @@ 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.
 
 ```js
-angledLineToY(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+angledLineToY(
+  data: AngledLineToData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/appearance.md b/docs/kcl/appearance.md
@@ -9,7 +9,12 @@ Set the appearance of a solid. This only works on solids, not sketches or indivi
 This will work on any solid, including extruded solids, revolved solids, and shelled solids.
 
 ```js
-appearance(solidSet: SolidSet, color: String, metalness?: number, roughness?: number) -> SolidSet
+appearance(
+  solidSet: SolidSet,
+  color: String,
+  metalness?: number,
+  roughness?: number,
+) -> SolidSet
 ```
 
 

diff --git a/docs/kcl/arc.md b/docs/kcl/arc.md
@@ -11,7 +11,11 @@ The arc is constructed such that the current position of the sketch is placed al
 Unless this makes a lot of sense and feels like what you're looking for to construct your shape, you're likely looking for tangentialArc.
 
 ```js
-arc(data: ArcData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+arc(
+  data: ArcData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/arcTo.md b/docs/kcl/arcTo.md
@@ -9,7 +9,11 @@ Draw a 3 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.
 
 ```js
-arcTo(data: ArcToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+arcTo(
+  data: ArcToData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/assert.md b/docs/kcl/assert.md
@@ -9,7 +9,10 @@ Check a value at runtime, and raise an error if the argument provided
 is false.
 
 ```js
-assert(data: bool, message: string) -> ()
+assert(
+  data: bool,
+  message: string,
+) -> ()
 ```
 
 

diff --git a/docs/kcl/assertEqual.md b/docs/kcl/assertEqual.md
@@ -9,7 +9,12 @@ Check that a numerical value equals another at runtime,
 otherwise raise an error.
 
 ```js
-assertEqual(left: number, right: number, epsilon: number, message: string) -> ()
+assertEqual(
+  left: number,
+  right: number,
+  epsilon: number,
+  message: string,
+) -> ()
 ```
 
 

diff --git a/docs/kcl/assertGreaterThan.md b/docs/kcl/assertGreaterThan.md
@@ -9,7 +9,11 @@ Check that a numerical value is greater than another at runtime,
 otherwise raise an error.
 
 ```js
-assertGreaterThan(left: number, right: number, message: string) -> ()
+assertGreaterThan(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

diff --git a/docs/kcl/assertGreaterThanOrEq.md b/docs/kcl/assertGreaterThanOrEq.md
@@ -9,7 +9,11 @@ Check that a numerical value is greater than or equal to another at runtime,
 otherwise raise an error.
 
 ```js
-assertGreaterThanOrEq(left: number, right: number, message: string) -> ()
+assertGreaterThanOrEq(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

diff --git a/docs/kcl/assertLessThan.md b/docs/kcl/assertLessThan.md
@@ -9,7 +9,11 @@ Check that a numerical value is less than to another at runtime,
 otherwise raise an error.
 
 ```js
-assertLessThan(left: number, right: number, message: string) -> ()
+assertLessThan(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

diff --git a/docs/kcl/assertLessThanOrEq.md b/docs/kcl/assertLessThanOrEq.md
@@ -9,7 +9,11 @@ Check that a numerical value is less than or equal to another at runtime,
 otherwise raise an error.
 
 ```js
-assertLessThanOrEq(left: number, right: number, message: string) -> ()
+assertLessThanOrEq(
+  left: number,
+  right: number,
+  message: string,
+) -> ()
 ```
 
 

diff --git a/docs/kcl/atan2.md b/docs/kcl/atan2.md
@@ -9,7 +9,10 @@ Compute the four quadrant arctangent of Y and X (in radians).
 
 
 ```js
-atan2(y: number, x: number) -> number
+atan2(
+  y: number,
+  x: number,
+) -> number
 ```
 
 ### Tags

diff --git a/docs/kcl/bezierCurve.md b/docs/kcl/bezierCurve.md
@@ -9,7 +9,11 @@ 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.
 
 ```js
-bezierCurve(data: BezierData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
+bezierCurve(
+  data: BezierData,
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/chamfer.md b/docs/kcl/chamfer.md
@@ -9,7 +9,12 @@ Cut a straight transitional edge along a tagged path.
 Chamfer is similar in function and use to a fillet, except a fillet will blend the transition along an edge, rather than cut a sharp, straight transitional edge.
 
 ```js
-chamfer(solid: Solid, length: number, tags: [EdgeReference], tag?: TagDeclarator) -> Solid
+chamfer(
+  solid: Solid,
+  length: number,
+  tags: [EdgeReference],
+  tag?: TagDeclarator,
+) -> Solid
 ```
 
 

diff --git a/docs/kcl/circle.md b/docs/kcl/circle.md
@@ -9,7 +9,11 @@ Construct a 2-dimensional circle, of the specified radius, centered at
 the provided (x, y) origin point.
 
 ```js
-circle(data: CircleData, sketchSurfaceOrGroup: SketchOrSurface, tag?: TagDeclarator) -> Sketch
+circle(
+  data: CircleData,
+  sketchSurfaceOrGroup: SketchOrSurface,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/circleThreePoint.md b/docs/kcl/circleThreePoint.md
@@ -9,7 +9,13 @@ Construct a circle derived from 3 points.
 
 
 ```js
-circleThreePoint(p1: [number], p2: [number], p3: [number], sketchSurfaceOrGroup: SketchOrSurface, tag?: TagDeclarator) -> Sketch
+circleThreePoint(
+  p1: [number],
+  p2: [number],
+  p3: [number],
+  sketchSurfaceOrGroup: SketchOrSurface,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/close.md b/docs/kcl/close.md
@@ -9,7 +9,10 @@ Construct a line segment from the current origin back to the profile's
 origin, ensuring the resulting 2-dimensional sketch is not open-ended.
 
 ```js
-close(sketch: Sketch, tag?: TagDeclarator) -> Sketch
+close(
+  sketch: Sketch,
+  tag?: TagDeclarator,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/extrude.md b/docs/kcl/extrude.md
@@ -9,7 +9,10 @@ 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.
 
 ```js
-extrude(sketchSet: SketchSet, length: number) -> SolidSet
+extrude(
+  sketchSet: SketchSet,
+  length: number,
+) -> SolidSet
 ```
 
 

diff --git a/docs/kcl/fillet.md b/docs/kcl/fillet.md
@@ -9,7 +9,13 @@ Blend a transitional edge along a tagged path, smoothing the sharp edge.
 Fillet is similar in function and use to a chamfer, except a chamfer will cut a sharp transition along an edge while fillet will smoothly blend the transition.
 
 ```js
-fillet(solid: Solid, radius: number, tags: [EdgeReference], tolerance?: number, tag?: TagDeclarator) -> Solid
+fillet(
+  solid: Solid,
+  radius: number,
+  tags: [EdgeReference],
+  tolerance?: number,
+  tag?: TagDeclarator,
+) -> Solid
 ```
 
 

diff --git a/docs/kcl/helix.md b/docs/kcl/helix.md
@@ -9,7 +9,14 @@ Create a helix.
 
 
 ```js
-helix(revolutions: number, angleStart: number, ccw?: bool, radius: number, axis: Axis3dOrEdgeReference, length?: number) -> HelixValue
+helix(
+  revolutions: number,
+  angleStart: number,
+  ccw?: bool,
+  radius: number,
+  axis: Axis3dOrEdgeReference,
+  length?: number,
+) -> HelixValue
 ```
 
 

diff --git a/docs/kcl/helixRevolutions.md b/docs/kcl/helixRevolutions.md
@@ -9,7 +9,10 @@ Create a helix on a cylinder.
 
 
 ```js
-helixRevolutions(data: HelixRevolutionsData, solid: Solid) -> Solid
+helixRevolutions(
+  data: HelixRevolutionsData,
+  solid: Solid,
+) -> Solid
 ```
 
 

diff --git a/docs/kcl/hole.md b/docs/kcl/hole.md
@@ -9,7 +9,10 @@ Use a 2-dimensional sketch to cut a hole in another 2-dimensional sketch.
 
 
 ```js
-hole(holeSketch: SketchSet, sketch: Sketch) -> Sketch
+hole(
+  holeSketch: SketchSet,
+  sketch: Sketch,
+) -> Sketch
 ```
 
 

diff --git a/docs/kcl/hollow.md b/docs/kcl/hollow.md
@@ -9,7 +9,10 @@ Make the inside of a 3D object hollow.
 Remove volume from a 3-dimensional shape such that a wall of the provided thickness remains around the exterior of the shape.
 
 ```js
-hollow(thickness: number, solid: Solid) -> Solid
+hollow(
+  thickness: number,
+  solid: Solid,
+) -> Solid
 ```
 
 

diff --git a/docs/kcl/import.md b/docs/kcl/import.md
@@ -15,7 +15,10 @@ For formats lacking unit data (such as STL, OBJ, or PLY files), the default unit
 Note: The import command currently only works when using the native Modeling App.
 
 ```js
-import(filePath: String, options?: ImportFormat) -> ImportedGeometry
+import(
+  filePath: String,
+  options?: ImportFormat,
+) -> ImportedGeometry
 ```