Declare std in KCL

KittyCAD · Feb 14, 2025 · e22402e · e22402e
1 parent 8c5662e
commit e22402e
Show file tree

Hide file tree

Showing 205 changed files with 16,816 additions and 1,489 deletions.
diff --git a/docs/kcl/HALF_TURN.md b/docs/kcl/HALF_TURN.md
@@ -0,0 +1,15 @@
+---
+title: "HALF_TURN"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+HALF_TURN: number(deg) = 180deg
+```
+
+
diff --git a/docs/kcl/QUARTER_TURN.md b/docs/kcl/QUARTER_TURN.md
@@ -0,0 +1,15 @@
+---
+title: "QUARTER_TURN"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+QUARTER_TURN: number(deg) = 90deg
+```
+
+
diff --git a/docs/kcl/THREE_QUARTER_TURN.md b/docs/kcl/THREE_QUARTER_TURN.md
@@ -0,0 +1,15 @@
+---
+title: "THREE_QUARTER_TURN"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+THREE_QUARTER_TURN: number(deg) = 270deg
+```
+
+
diff --git a/docs/kcl/ZERO.md b/docs/kcl/ZERO.md
@@ -0,0 +1,15 @@
+---
+title: "ZERO"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+ZERO: number = 0
+```
+
+
diff --git a/docs/kcl/abs.md b/docs/kcl/abs.md
@@ -25,7 +25,7 @@ abs(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/acos.md b/docs/kcl/acos.md
@@ -25,7 +25,7 @@ acos(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/angleToMatchLengthX.md b/docs/kcl/angleToMatchLengthX.md
@@ -23,7 +23,7 @@ angleToMatchLengthX(tag: TagIdentifier, to: number, sketch: Sketch) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/angleToMatchLengthY.md b/docs/kcl/angleToMatchLengthY.md
@@ -23,7 +23,7 @@ angleToMatchLengthY(tag: TagIdentifier, to: number, sketch: Sketch) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/appearance.md b/docs/kcl/appearance.md
diff --git a/docs/kcl/asin.md b/docs/kcl/asin.md
@@ -25,7 +25,7 @@ asin(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/assert.md b/docs/kcl/assert.md
@@ -22,7 +22,7 @@ assert(data: bool, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

diff --git a/docs/kcl/assertEqual.md b/docs/kcl/assertEqual.md
@@ -24,7 +24,7 @@ assertEqual(left: number, right: number, epsilon: number, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

diff --git a/docs/kcl/assertGreaterThan.md b/docs/kcl/assertGreaterThan.md
@@ -23,7 +23,7 @@ assertGreaterThan(left: number, right: number, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

diff --git a/docs/kcl/assertGreaterThanOrEq.md b/docs/kcl/assertGreaterThanOrEq.md
@@ -23,7 +23,7 @@ assertGreaterThanOrEq(left: number, right: number, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

diff --git a/docs/kcl/assertLessThan.md b/docs/kcl/assertLessThan.md
@@ -23,7 +23,7 @@ assertLessThan(left: number, right: number, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

diff --git a/docs/kcl/assertLessThanOrEq.md b/docs/kcl/assertLessThanOrEq.md
@@ -23,7 +23,7 @@ assertLessThanOrEq(left: number, right: number, message: string) -> ()
 
 ### Returns
 
-`()` 
+`()`
 
 
 ### Examples

diff --git a/docs/kcl/atan.md b/docs/kcl/atan.md
@@ -25,7 +25,7 @@ atan(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/atan2.md b/docs/kcl/atan2.md
@@ -26,7 +26,7 @@ atan2(y: number, x: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/ceil.md b/docs/kcl/ceil.md
@@ -25,7 +25,7 @@ ceil(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/cm.md b/docs/kcl/cm.md
@@ -26,7 +26,7 @@ cm() -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/const_E.md b/docs/kcl/const_E.md
diff --git a/docs/kcl/const_HALF_TURN.md b/docs/kcl/const_HALF_TURN.md
@@ -0,0 +1,15 @@
+---
+title: "HALF_TURN"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+HALF_TURN: number(deg) = 180deg
+```
+
+
diff --git a/docs/kcl/const_PI.md b/docs/kcl/const_PI.md
diff --git a/docs/kcl/const_QUARTER_TURN.md b/docs/kcl/const_QUARTER_TURN.md
@@ -0,0 +1,15 @@
+---
+title: "QUARTER_TURN"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+QUARTER_TURN: number(deg) = 90deg
+```
+
+
diff --git a/docs/kcl/const_TAU.md b/docs/kcl/const_TAU.md
diff --git a/docs/kcl/const_THREE_QUARTER_TURN.md b/docs/kcl/const_THREE_QUARTER_TURN.md
@@ -0,0 +1,15 @@
+---
+title: "THREE_QUARTER_TURN"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+THREE_QUARTER_TURN: number(deg) = 270deg
+```
+
+
diff --git a/docs/kcl/const_ZERO.md b/docs/kcl/const_ZERO.md
@@ -0,0 +1,15 @@
+---
+title: "ZERO"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+ZERO: number = 0
+```
+
+
diff --git a/docs/kcl/const_const_std-math-E.md b/docs/kcl/const_const_std-math-E.md
diff --git a/docs/kcl/const_const_std-math-PI.md b/docs/kcl/const_const_std-math-PI.md
diff --git a/docs/kcl/const_const_std-math-TAU.md b/docs/kcl/const_const_std-math-TAU.md
diff --git a/docs/kcl/const_const_std-prelude-HALF_TURN.md b/docs/kcl/const_const_std-prelude-HALF_TURN.md
@@ -0,0 +1,15 @@
+---
+title: "std::prelude::HALF_TURN"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+std::prelude::HALF_TURN: number(deg) = 180deg
+```
+
+
diff --git a/docs/kcl/const_const_std-prelude-QUARTER_TURN.md b/docs/kcl/const_const_std-prelude-QUARTER_TURN.md
@@ -0,0 +1,15 @@
+---
+title: "std::prelude::QUARTER_TURN"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+std::prelude::QUARTER_TURN: number(deg) = 90deg
+```
+
+
diff --git a/docs/kcl/const_const_std-prelude-THREE_QUARTER_TURN.md b/docs/kcl/const_const_std-prelude-THREE_QUARTER_TURN.md
@@ -0,0 +1,15 @@
+---
+title: "std::prelude::THREE_QUARTER_TURN"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+std::prelude::THREE_QUARTER_TURN: number(deg) = 270deg
+```
+
+
diff --git a/docs/kcl/const_const_std-prelude-ZERO.md b/docs/kcl/const_const_std-prelude-ZERO.md
@@ -0,0 +1,15 @@
+---
+title: "std::prelude::ZERO"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+std::prelude::ZERO: number = 0
+```
+
+
diff --git a/docs/kcl/cos.md b/docs/kcl/cos.md
diff --git a/docs/kcl/e.md b/docs/kcl/e.md
@@ -4,9 +4,11 @@ excerpt: "Return the value of Euler’s number `e`."
 layout: manual
 ---
 
-Return the value of Euler’s number `e`.
+**WARNING:** This function is deprecated.
 
+Return the value of Euler’s number `e`.
 
+**DEPRECATED** use the constant E
 
 ```js
 e() -> number
@@ -20,7 +22,7 @@ e() -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/floor.md b/docs/kcl/floor.md
@@ -25,7 +25,7 @@ floor(num: number) -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/ft.md b/docs/kcl/ft.md
@@ -26,7 +26,7 @@ ft() -> number
 
 ### Returns
 
-`number` 
+`number`
 
 
 ### Examples

diff --git a/docs/kcl/getNextAdjacentEdge.md b/docs/kcl/getNextAdjacentEdge.md
@@ -21,7 +21,7 @@ getNextAdjacentEdge(tag: TagIdentifier) -> Uuid
 
 ### Returns
 
-`Uuid` 
+`Uuid`
 
 
 ### Examples

diff --git a/docs/kcl/getOppositeEdge.md b/docs/kcl/getOppositeEdge.md
@@ -21,7 +21,7 @@ getOppositeEdge(tag: TagIdentifier) -> Uuid
 
 ### Returns
 
-`Uuid` 
+`Uuid`
 
 
 ### Examples

diff --git a/docs/kcl/getPreviousAdjacentEdge.md b/docs/kcl/getPreviousAdjacentEdge.md
@@ -21,7 +21,7 @@ getPreviousAdjacentEdge(tag: TagIdentifier) -> Uuid
 
 ### Returns
 
-`Uuid` 
+`Uuid`
 
 
 ### Examples
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,7 +22,7 @@ assert(data: bool, message: string) -> () @@
     ### Returns
-    `()`
+    `()`
     ### Examples
@@ Expand Down @@