More docs fixes (#6733)

* Fix various docs errors around std module Signed-off-by: Nick Cameron <nrc@ncameron.org> * remove KCL from lang docs titles and move settings docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Include functions declared in Rust in module docs Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-08 08:26:56 +12:00
parent 43d5a72514
commit 2fee3a424c
84 changed files with 203 additions and 100 deletions
--- a/docs/kcl-std/functions/std-helix.md
+++ b/docs/kcl-std/functions/std-helix.md
@ -1,6 +1,6 @@
 ---
 title: "helix"
-subtitle: "Function in prelude"
+subtitle: "Function in std"
 excerpt: "Create a helix."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-abs.md
+++ b/docs/kcl-std/functions/std-math-abs.md
@ -1,6 +1,6 @@
 ---
 title: "abs"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the absolute value of a number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-acos.md
+++ b/docs/kcl-std/functions/std-math-acos.md
@ -1,6 +1,6 @@
 ---
 title: "acos"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the arccosine of a number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-asin.md
+++ b/docs/kcl-std/functions/std-math-asin.md
@ -1,6 +1,6 @@
 ---
 title: "asin"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the arcsine of a number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-atan.md
+++ b/docs/kcl-std/functions/std-math-atan.md
@ -1,6 +1,6 @@
 ---
 title: "atan"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the arctangent of a number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-atan2.md
+++ b/docs/kcl-std/functions/std-math-atan2.md
@ -1,6 +1,6 @@
 ---
 title: "atan2"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the four quadrant arctangent of Y and X."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-ceil.md
+++ b/docs/kcl-std/functions/std-math-ceil.md
@ -1,6 +1,6 @@
 ---
 title: "ceil"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the smallest integer greater than or equal to a number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-cos.md
+++ b/docs/kcl-std/functions/std-math-cos.md
@ -1,6 +1,6 @@
 ---
 title: "cos"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the cosine of a number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-floor.md
+++ b/docs/kcl-std/functions/std-math-floor.md
@ -1,6 +1,6 @@
 ---
 title: "floor"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the largest integer less than or equal to a number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-ln.md
+++ b/docs/kcl-std/functions/std-math-ln.md
@ -1,6 +1,6 @@
 ---
 title: "ln"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the natural logarithm of the number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-log.md
+++ b/docs/kcl-std/functions/std-math-log.md
@ -1,6 +1,6 @@
 ---
 title: "log"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the logarithm of the number with respect to an arbitrary base."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-log10.md
+++ b/docs/kcl-std/functions/std-math-log10.md
@ -1,6 +1,6 @@
 ---
 title: "log10"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the base 10 logarithm of the number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-log2.md
+++ b/docs/kcl-std/functions/std-math-log2.md
@ -1,6 +1,6 @@
 ---
 title: "log2"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the base 2 logarithm of the number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-max.md
+++ b/docs/kcl-std/functions/std-math-max.md
@ -1,6 +1,6 @@
 ---
 title: "max"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the maximum of the given arguments."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-min.md
+++ b/docs/kcl-std/functions/std-math-min.md
@ -1,6 +1,6 @@
 ---
 title: "min"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the minimum of the given arguments."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-polar.md
+++ b/docs/kcl-std/functions/std-math-polar.md
@ -1,6 +1,6 @@
 ---
 title: "polar"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: ""
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-pow.md
+++ b/docs/kcl-std/functions/std-math-pow.md
@ -1,6 +1,6 @@
 ---
 title: "pow"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the number to a power."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-rem.md
+++ b/docs/kcl-std/functions/std-math-rem.md
@ -1,6 +1,6 @@
 ---
 title: "rem"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: ""
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-round.md
+++ b/docs/kcl-std/functions/std-math-round.md
@ -1,6 +1,6 @@
 ---
 title: "round"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Round a number to the nearest integer."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-sin.md
+++ b/docs/kcl-std/functions/std-math-sin.md
@ -1,6 +1,6 @@
 ---
 title: "sin"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the sine of a number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-sqrt.md
+++ b/docs/kcl-std/functions/std-math-sqrt.md
@ -1,6 +1,6 @@
 ---
 title: "sqrt"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the square root of a number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-math-tan.md
+++ b/docs/kcl-std/functions/std-math-tan.md
@ -1,6 +1,6 @@
 ---
 title: "tan"
-subtitle: "Function in math"
+subtitle: "Function in std::math"
 excerpt: "Compute the tangent of a number."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-offsetPlane.md
+++ b/docs/kcl-std/functions/std-offsetPlane.md
@ -1,6 +1,6 @@
 ---
 title: "offsetPlane"
-subtitle: "Function in prelude"
+subtitle: "Function in std"
 excerpt: "Offset a plane by a distance along its normal."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-sketch-circle.md
+++ b/docs/kcl-std/functions/std-sketch-circle.md
@ -1,6 +1,6 @@
 ---
 title: "circle"
-subtitle: "Function in sketch"
+subtitle: "Function in std::sketch"
 excerpt: ""
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-sketch-revolve.md
+++ b/docs/kcl-std/functions/std-sketch-revolve.md
@ -1,6 +1,6 @@
 ---
 title: "revolve"
-subtitle: "Function in sketch"
+subtitle: "Function in std::sketch"
 excerpt: "Rotate a sketch around some provided axis, creating a solid from its extent."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-solid-chamfer.md
+++ b/docs/kcl-std/functions/std-solid-chamfer.md
@ -1,6 +1,6 @@
 ---
 title: "chamfer"
-subtitle: "Function in solid"
+subtitle: "Function in std::solid"
 excerpt: "Cut a straight transitional edge along a tagged path."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-solid-fillet.md
+++ b/docs/kcl-std/functions/std-solid-fillet.md
@ -1,6 +1,6 @@
 ---
 title: "fillet"
-subtitle: "Function in solid"
+subtitle: "Function in std::solid"
 excerpt: "Blend a transitional edge along a tagged path, smoothing the sharp edge."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-solid-hollow.md
+++ b/docs/kcl-std/functions/std-solid-hollow.md
@ -1,6 +1,6 @@
 ---
 title: "hollow"
-subtitle: "Function in solid"
+subtitle: "Function in std::solid"
 excerpt: "Make the inside of a 3D object hollow."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-solid-shell.md
+++ b/docs/kcl-std/functions/std-solid-shell.md
@ -1,6 +1,6 @@
 ---
 title: "shell"
-subtitle: "Function in solid"
+subtitle: "Function in std::solid"
 excerpt: ""
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-transform-mirror2d.md
+++ b/docs/kcl-std/functions/std-transform-mirror2d.md
@ -1,6 +1,6 @@
 ---
 title: "mirror2d"
-subtitle: "Function in transform"
+subtitle: "Function in std::transform"
 excerpt: "Mirror a sketch."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-units-toCentimeters.md
+++ b/docs/kcl-std/functions/std-units-toCentimeters.md
@ -1,6 +1,6 @@
 ---
 title: "units::toCentimeters"
-subtitle: "Function in units"
+subtitle: "Function in std::units"
 excerpt: "Convert a number to centimeters from its current units."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-units-toDegrees.md
+++ b/docs/kcl-std/functions/std-units-toDegrees.md
@ -1,6 +1,6 @@
 ---
 title: "units::toDegrees"
-subtitle: "Function in units"
+subtitle: "Function in std::units"
 excerpt: "Converts a number to degrees from its current units."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-units-toFeet.md
+++ b/docs/kcl-std/functions/std-units-toFeet.md
@ -1,6 +1,6 @@
 ---
 title: "units::toFeet"
-subtitle: "Function in units"
+subtitle: "Function in std::units"
 excerpt: "Convert a number to feet from its current units."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-units-toInches.md
+++ b/docs/kcl-std/functions/std-units-toInches.md
@ -1,6 +1,6 @@
 ---
 title: "units::toInches"
-subtitle: "Function in units"
+subtitle: "Function in std::units"
 excerpt: "Convert a number to inches from its current units."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-units-toMeters.md
+++ b/docs/kcl-std/functions/std-units-toMeters.md
@ -1,6 +1,6 @@
 ---
 title: "units::toMeters"
-subtitle: "Function in units"
+subtitle: "Function in std::units"
 excerpt: "Convert a number to meters from its current units."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-units-toMillimeters.md
+++ b/docs/kcl-std/functions/std-units-toMillimeters.md
@ -1,6 +1,6 @@
 ---
 title: "units::toMillimeters"
-subtitle: "Function in units"
+subtitle: "Function in std::units"
 excerpt: "Convert a number to millimeters from its current units."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-units-toRadians.md
+++ b/docs/kcl-std/functions/std-units-toRadians.md
@ -1,6 +1,6 @@
 ---
 title: "units::toRadians"
-subtitle: "Function in units"
+subtitle: "Function in std::units"
 excerpt: "Converts a number to radians from its current units."
 layout: manual
 ---
--- a/docs/kcl-std/functions/std-units-toYards.md
+++ b/docs/kcl-std/functions/std-units-toYards.md
@ -1,6 +1,6 @@
 ---
 title: "units::toYards"
-subtitle: "Function in units"
+subtitle: "Function in std::units"
 excerpt: "Converts a number to yards from its current units."
 layout: manual
 ---