dont escape the markdown shit (#4049)
Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
		
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -6,7 +6,7 @@ layout: manual
 | 
			
		||||
 | 
			
		||||
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.
 | 
			
		||||
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
 | 
			
		||||
 | 
			
		||||
@ -6,7 +6,7 @@ layout: manual
 | 
			
		||||
 | 
			
		||||
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.
 | 
			
		||||
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
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -6,7 +6,7 @@ layout: manual
 | 
			
		||||
 | 
			
		||||
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.
 | 
			
		||||
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
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -8,11 +8,11 @@ Centimeters conversion factor for current projects units.
 | 
			
		||||
 | 
			
		||||
No matter what units the current project uses, this function will always return the conversion factor to centimeters.
 | 
			
		||||
 | 
			
		||||
For example, if the current project uses inches, this function will return `0.393701`. If the current project uses millimeters, this function will return `10`. If the current project uses centimeters, this function will return `1`.
 | 
			
		||||
For example, if the current project uses inches, this function will return `0.393701`. If the current project uses millimeters, this function will return `10`. If the current project uses centimeters, this function will return `1`.
 | 
			
		||||
 | 
			
		||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
 | 
			
		||||
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * cm()` is more readable that your intent is "I want 10 centimeters" than `10 * 10`, if the project settings are in millimeters.
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * cm()` is more readable that your intent is "I want 10 centimeters" than `10 * 10`, if the project settings are in millimeters.
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
cm() -> number
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -8,11 +8,11 @@ Feet conversion factor for current projects units.
 | 
			
		||||
 | 
			
		||||
No matter what units the current project uses, this function will always return the conversion factor to feet.
 | 
			
		||||
 | 
			
		||||
For example, if the current project uses inches, this function will return `12`. If the current project uses millimeters, this function will return `304.8`. If the current project uses feet, this function will return `1`.
 | 
			
		||||
For example, if the current project uses inches, this function will return `12`. If the current project uses millimeters, this function will return `304.8`. If the current project uses feet, this function will return `1`.
 | 
			
		||||
 | 
			
		||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
 | 
			
		||||
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * ft()` is more readable that your intent is "I want 10 feet" than `10 * 304.8`, if the project settings are in millimeters.
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * ft()` is more readable that your intent is "I want 10 feet" than `10 * 304.8`, if the project settings are in millimeters.
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
ft() -> number
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -8,11 +8,11 @@ Inches conversion factor for current projects units.
 | 
			
		||||
 | 
			
		||||
No matter what units the current project uses, this function will always return the conversion factor to inches.
 | 
			
		||||
 | 
			
		||||
For example, if the current project uses inches, this function will return `1`. If the current project uses millimeters, this function will return `25.4`.
 | 
			
		||||
For example, if the current project uses inches, this function will return `1`. If the current project uses millimeters, this function will return `25.4`.
 | 
			
		||||
 | 
			
		||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
 | 
			
		||||
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * inch()` is more readable that your intent is "I want 10 inches" than `10 * 25.4`, if the project settings are in millimeters.
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * inch()` is more readable that your intent is "I want 10 inches" than `10 * 25.4`, if the project settings are in millimeters.
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
inch() -> number
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -4,7 +4,7 @@ excerpt: "Extract the 'y' axis value of the last line segment in the provided 2-
 | 
			
		||||
layout: manual
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
Extract the 'y' axis value of the last line segment in the provided 2-d
 | 
			
		||||
Extract the 'y' axis value of the last line segment in the provided 2-d
 | 
			
		||||
 | 
			
		||||
sketch.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -6,7 +6,7 @@ layout: manual
 | 
			
		||||
 | 
			
		||||
Compute the logarithm of the number with respect to an arbitrary base.
 | 
			
		||||
 | 
			
		||||
The result might not be correctly rounded owing to implementation details; `log2()` can produce more accurate results for base 2, and `log10()` can produce more accurate results for base 10.
 | 
			
		||||
The result might not be correctly rounded owing to implementation details; `log2()` can produce more accurate results for base 2, and `log10()` can produce more accurate results for base 10.
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
log(num: number, base: number) -> number
 | 
			
		||||
 | 
			
		||||
@ -8,11 +8,11 @@ Meters conversion factor for current projects units.
 | 
			
		||||
 | 
			
		||||
No matter what units the current project uses, this function will always return the conversion factor to meters.
 | 
			
		||||
 | 
			
		||||
For example, if the current project uses inches, this function will return `39.3701`. If the current project uses millimeters, this function will return `1000`. If the current project uses meters, this function will return `1`.
 | 
			
		||||
For example, if the current project uses inches, this function will return `39.3701`. If the current project uses millimeters, this function will return `1000`. If the current project uses meters, this function will return `1`.
 | 
			
		||||
 | 
			
		||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
 | 
			
		||||
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * m()` is more readable that your intent is "I want 10 meters" than `10 * 1000`, if the project settings are in millimeters.
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * m()` is more readable that your intent is "I want 10 meters" than `10 * 1000`, if the project settings are in millimeters.
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
m() -> number
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -8,11 +8,11 @@ Millimeters conversion factor for current projects units.
 | 
			
		||||
 | 
			
		||||
No matter what units the current project uses, this function will always return the conversion factor to millimeters.
 | 
			
		||||
 | 
			
		||||
For example, if the current project uses inches, this function will return `(1/25.4)`. If the current project uses millimeters, this function will return `1`.
 | 
			
		||||
For example, if the current project uses inches, this function will return `(1/25.4)`. If the current project uses millimeters, this function will return `1`.
 | 
			
		||||
 | 
			
		||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
 | 
			
		||||
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * mm()` is more readable that your intent is "I want 10 millimeters" than `10 * (1/25.4)`, if the project settings are in inches.
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * mm()` is more readable that your intent is "I want 10 millimeters" than `10 * (1/25.4)`, if the project settings are in inches.
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
mm() -> number
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -4,7 +4,7 @@ excerpt: "Extract the provided 2-dimensional sketch's profile's origin"
 | 
			
		||||
layout: manual
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
Extract the provided 2-dimensional sketch's profile's origin
 | 
			
		||||
Extract the provided 2-dimensional sketch's profile's origin
 | 
			
		||||
 | 
			
		||||
value.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -4,7 +4,7 @@ excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'y'"
 | 
			
		||||
layout: manual
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
Extract the provided 2-dimensional sketch's profile's origin's 'y'
 | 
			
		||||
Extract the provided 2-dimensional sketch's profile's origin's 'y'
 | 
			
		||||
 | 
			
		||||
value.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -4,9 +4,9 @@ excerpt: "Compute the remainder after dividing `num` by `div`."
 | 
			
		||||
layout: manual
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
Compute the remainder after dividing `num` by `div`.
 | 
			
		||||
Compute the remainder after dividing `num` by `div`.
 | 
			
		||||
 | 
			
		||||
If `num` is negative, the result will be too.
 | 
			
		||||
If `num` is negative, the result will be too.
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
rem(num: i64, divisor: i64) -> i64
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -4,7 +4,7 @@ excerpt: "Compute the ending point of the provided line segment along the 'x' ax
 | 
			
		||||
layout: manual
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
Compute the ending point of the provided line segment along the 'x' axis.
 | 
			
		||||
Compute the ending point of the provided line segment along the 'x' axis.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -16,7 +16,7 @@ See [cglearn.eu] for background reading.
 | 
			
		||||
 | 
			
		||||
**This schema accepts exactly one of the following:**
 | 
			
		||||
 | 
			
		||||
'Y' axis.
 | 
			
		||||
'Y' axis.
 | 
			
		||||
 | 
			
		||||
**enum:** `y`
 | 
			
		||||
 | 
			
		||||
@ -28,7 +28,7 @@ See [cglearn.eu] for background reading.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
----
 | 
			
		||||
'Z' axis.
 | 
			
		||||
'Z' axis.
 | 
			
		||||
 | 
			
		||||
**enum:** `z`
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -4,7 +4,7 @@ excerpt: "An [[`Axis`](/docs/kcl/types/Axis)] paired with a [[`Direction`](/docs
 | 
			
		||||
layout: manual
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
An [`Axis`] paired with a [`Direction`].
 | 
			
		||||
An [[`Axis`](/docs/kcl/types/Axis)] paired with a [[`Direction`](/docs/kcl/types/Direction)].
 | 
			
		||||
 | 
			
		||||
**Type:** `object`
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -16,7 +16,7 @@ Data for a circular pattern on a 2D sketch.
 | 
			
		||||
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `repetitions` |[`Uint`](/docs/kcl/types/Uint)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if `repetitions` is 1, the original entity will be copied once. | No |
 | 
			
		||||
| `repetitions` |[`Uint`](/docs/kcl/types/Uint)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if `repetitions` is 1, the original entity will be copied once. | No |
 | 
			
		||||
| `center` |`[number, number]`| The center about which to make the pattern. This is a 2D vector. | No |
 | 
			
		||||
| `arcDegrees` |`number`| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
 | 
			
		||||
| `rotateDuplicates` |`boolean`| Whether or not to rotate the duplicates as they are copied. | No |
 | 
			
		||||
 | 
			
		||||
@ -16,7 +16,7 @@ Data for a circular pattern on a 3D model.
 | 
			
		||||
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `repetitions` |[`Uint`](/docs/kcl/types/Uint)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if `repetitions` is 1, the original entity will be copied once. | No |
 | 
			
		||||
| `repetitions` |[`Uint`](/docs/kcl/types/Uint)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if `repetitions` is 1, the original entity will be copied once. | No |
 | 
			
		||||
| `axis` |`[number, number, number]`| The axis around which to make the pattern. This is a 3D vector. | No |
 | 
			
		||||
| `center` |`[number, number, number]`| The center about which to make the pattern. This is a 3D vector. | No |
 | 
			
		||||
| `arcDegrees` |`number`| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
 | 
			
		||||
 | 
			
		||||
@ -18,7 +18,7 @@ Data for helices.
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `revolutions` |`number`| Number of revolutions. | No |
 | 
			
		||||
| `angleStart` |`number`| Start angle (in degrees). | No |
 | 
			
		||||
| `ccw` |`boolean`| Is the helix rotation counter clockwise? The default is `false`. | No |
 | 
			
		||||
| `ccw` |`boolean`| Is the helix rotation counter clockwise? The default is `false`. | No |
 | 
			
		||||
| `length` |`number`| Length of the helix. If this argument is not provided, the height of the solid is used. | No |
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -16,7 +16,7 @@ Data for a linear pattern on a 2D sketch.
 | 
			
		||||
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `repetitions` |[`Uint`](/docs/kcl/types/Uint)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if `repetitions` is 1, the original entity will be copied once. | No |
 | 
			
		||||
| `repetitions` |[`Uint`](/docs/kcl/types/Uint)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if `repetitions` is 1, the original entity will be copied once. | No |
 | 
			
		||||
| `distance` |`number`| The distance between each repetition. This can also be referred to as spacing. | No |
 | 
			
		||||
| `axis` |`[number, number]`| The axis of the pattern. This is a 2D vector. | No |
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -16,7 +16,7 @@ Data for a linear pattern on a 3D model.
 | 
			
		||||
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `repetitions` |[`Uint`](/docs/kcl/types/Uint)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if `repetitions` is 1, the original entity will be copied once. | No |
 | 
			
		||||
| `repetitions` |[`Uint`](/docs/kcl/types/Uint)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if `repetitions` is 1, the original entity will be copied once. | No |
 | 
			
		||||
| `distance` |`number`| The distance between each repetition. This can also be referred to as spacing. | No |
 | 
			
		||||
| `axis` |`[number, number, number]`| The axis of the pattern. | No |
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -17,7 +17,7 @@ Data for a loft.
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `vDegree` |`integer` (**minimum:** 1.0)| Degree of the interpolation. Must be greater than zero. For example, use 2 for quadratic, or 3 for cubic interpolation in the V direction. This defaults to 2, if not specified. | No |
 | 
			
		||||
| `bezApproximateRational` |`boolean`| Attempt to approximate rational curves (such as arcs) using a bezier. This will remove banding around interpolations between arcs and non-arcs.  It may produce errors in other scenarios Over time, this field won't be necessary. | No |
 | 
			
		||||
| `bezApproximateRational` |`boolean`| Attempt to approximate rational curves (such as arcs) using a bezier. This will remove banding around interpolations between arcs and non-arcs.  It may produce errors in other scenarios Over time, this field won't be necessary. | No |
 | 
			
		||||
| `baseCurveIndex` |`integer`| This can be set to override the automatically determined topological base curve, which is usually the first section encountered. | No |
 | 
			
		||||
| `tolerance` |`number`| Tolerance for the loft operation. | No |
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -45,8 +45,8 @@ A arc that is tangential to the last path segment that goes to a point
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `type` |enum: `TangentialArcTo`|  | No |
 | 
			
		||||
| `center` |`[number, number]`| the arc's center | No |
 | 
			
		||||
| `ccw` |`boolean`| arc's direction | No |
 | 
			
		||||
| `center` |`[number, number]`| the arc's center | No |
 | 
			
		||||
| `ccw` |`boolean`| arc's direction | No |
 | 
			
		||||
| `from` |`[number, number]`| The from point. | No |
 | 
			
		||||
| `to` |`[number, number]`| The to point. | No |
 | 
			
		||||
| `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | 
			
		||||
@ -67,8 +67,8 @@ A arc that is tangential to the last path segment
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `type` |enum: `TangentialArc`|  | No |
 | 
			
		||||
| `center` |`[number, number]`| the arc's center | No |
 | 
			
		||||
| `ccw` |`boolean`| arc's direction | No |
 | 
			
		||||
| `center` |`[number, number]`| the arc's center | No |
 | 
			
		||||
| `ccw` |`boolean`| arc's direction | No |
 | 
			
		||||
| `from` |`[number, number]`| The from point. | No |
 | 
			
		||||
| `to` |`[number, number]`| The to point. | No |
 | 
			
		||||
| `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | 
			
		||||
@ -89,9 +89,9 @@ a complete arc
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `type` |enum: `Circle`|  | No |
 | 
			
		||||
| `center` |`[number, number]`| the arc's center | No |
 | 
			
		||||
| `radius` |`number`| the arc's radius | No |
 | 
			
		||||
| `ccw` |`boolean`| arc's direction | No |
 | 
			
		||||
| `center` |`[number, number]`| the arc's center | No |
 | 
			
		||||
| `radius` |`number`| the arc's radius | No |
 | 
			
		||||
| `ccw` |`boolean`| arc's direction | No |
 | 
			
		||||
| `from` |`[number, number]`| The from point. | No |
 | 
			
		||||
| `to` |`[number, number]`| The to point. | No |
 | 
			
		||||
| `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
 | 
			
		||||
 | 
			
		||||
@ -16,7 +16,7 @@ A sketch is a collection of paths.
 | 
			
		||||
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `id` |`string`| The id of the sketch (this will change when the engine's reference to it changes. | No |
 | 
			
		||||
| `id` |`string`| The id of the sketch (this will change when the engine's reference to it changes. | No |
 | 
			
		||||
| `value` |`[` [`Path`](/docs/kcl/types/Path) `]`| The paths in the sketch. | No |
 | 
			
		||||
| `on` |[`SketchSurface`](/docs/kcl/types/SketchSurface)| What the sketch is on (can be a plane or a face). | No |
 | 
			
		||||
| `start` |[`BasePath`](/docs/kcl/types/BasePath)| The starting path. | No |
 | 
			
		||||
 | 
			
		||||
@ -25,7 +25,7 @@ A sketch is a collection of paths.
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `type` |enum: `sketch`|  | No |
 | 
			
		||||
| `id` |`string`| The id of the sketch (this will change when the engine's reference to it changes. | No |
 | 
			
		||||
| `id` |`string`| The id of the sketch (this will change when the engine's reference to it changes. | No |
 | 
			
		||||
| `value` |`[` [`Path`](/docs/kcl/types/Path) `]`| The paths in the sketch. | No |
 | 
			
		||||
| `on` |[`SketchSurface`](/docs/kcl/types/SketchSurface)| What the sketch is on (can be a plane or a face). | No |
 | 
			
		||||
| `start` |[`BasePath`](/docs/kcl/types/BasePath)| The starting path. | No |
 | 
			
		||||
 | 
			
		||||
@ -6,7 +6,7 @@ layout: manual
 | 
			
		||||
 | 
			
		||||
Co-ordinate system definition.
 | 
			
		||||
 | 
			
		||||
The `up` axis must be orthogonal to the `forward` axis.
 | 
			
		||||
The `up` axis must be orthogonal to the `forward` axis.
 | 
			
		||||
 | 
			
		||||
See [cglearn.eu] for background reading.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -12,7 +12,7 @@ The valid types of length units.
 | 
			
		||||
 | 
			
		||||
**This schema accepts exactly one of the following:**
 | 
			
		||||
 | 
			
		||||
Centimeters <https://en.wikipedia.org/wiki/Centimeter>
 | 
			
		||||
Centimeters <https://en.wikipedia.org/wiki/Centimeter>
 | 
			
		||||
 | 
			
		||||
**enum:** `cm`
 | 
			
		||||
 | 
			
		||||
@ -24,7 +24,7 @@ Centimeters <https://en.wikipedia.org/wiki/Centimeter>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
----
 | 
			
		||||
Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
 | 
			
		||||
Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
 | 
			
		||||
 | 
			
		||||
**enum:** `ft`
 | 
			
		||||
 | 
			
		||||
@ -36,7 +36,7 @@ Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
----
 | 
			
		||||
Inches <https://en.wikipedia.org/wiki/Inch>
 | 
			
		||||
Inches <https://en.wikipedia.org/wiki/Inch>
 | 
			
		||||
 | 
			
		||||
**enum:** `in`
 | 
			
		||||
 | 
			
		||||
@ -48,7 +48,7 @@ Inches <https://en.wikipedia.org/wiki/Inch>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
----
 | 
			
		||||
Meters <https://en.wikipedia.org/wiki/Meter>
 | 
			
		||||
Meters <https://en.wikipedia.org/wiki/Meter>
 | 
			
		||||
 | 
			
		||||
**enum:** `m`
 | 
			
		||||
 | 
			
		||||
@ -60,7 +60,7 @@ Meters <https://en.wikipedia.org/wiki/Meter>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
----
 | 
			
		||||
Millimeters <https://en.wikipedia.org/wiki/Millimeter>
 | 
			
		||||
Millimeters <https://en.wikipedia.org/wiki/Millimeter>
 | 
			
		||||
 | 
			
		||||
**enum:** `mm`
 | 
			
		||||
 | 
			
		||||
@ -72,7 +72,7 @@ Millimeters <https://en.wikipedia.org/wiki/Millimeter>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
----
 | 
			
		||||
Yards <https://en.wikipedia.org/wiki/Yard>
 | 
			
		||||
Yards <https://en.wikipedia.org/wiki/Yard>
 | 
			
		||||
 | 
			
		||||
**enum:** `yd`
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -6,7 +6,7 @@ layout: manual
 | 
			
		||||
 | 
			
		||||
Draw a line relative to the current origin to a specified distance away
 | 
			
		||||
 | 
			
		||||
from the current position along the 'x' axis.
 | 
			
		||||
from the current position along the 'x' axis.
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
xLine(length: number, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 | 
			
		||||
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@ -8,11 +8,11 @@ Yards conversion factor for current projects units.
 | 
			
		||||
 | 
			
		||||
No matter what units the current project uses, this function will always return the conversion factor to yards.
 | 
			
		||||
 | 
			
		||||
For example, if the current project uses inches, this function will return `36`. If the current project uses millimeters, this function will return `914.4`. If the current project uses yards, this function will return `1`.
 | 
			
		||||
For example, if the current project uses inches, this function will return `36`. If the current project uses millimeters, this function will return `914.4`. If the current project uses yards, this function will return `1`.
 | 
			
		||||
 | 
			
		||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
 | 
			
		||||
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * yd()` is more readable that your intent is "I want 10 yards" than `10 * 914.4`, if the project settings are in millimeters.
 | 
			
		||||
We merely provide these functions for convenience and readability, as `10 * yd()` is more readable that your intent is "I want 10 yards" than `10 * 914.4`, if the project settings are in millimeters.
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
yd() -> number
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										10
									
								
								src/wasm-lib/kcl/src/docs/templates/function.hbs
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										10
									
								
								src/wasm-lib/kcl/src/docs/templates/function.hbs
									
									
									
									
										vendored
									
									
								
							@ -8,9 +8,9 @@ layout: manual
 | 
			
		||||
**WARNING:** This function is deprecated.
 | 
			
		||||
 | 
			
		||||
{{/if}}
 | 
			
		||||
{{summary}}
 | 
			
		||||
{{{summary}}}
 | 
			
		||||
 | 
			
		||||
{{description}}
 | 
			
		||||
{{{description}}}
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
{{{fn_signature}}}
 | 
			
		||||
@ -31,14 +31,14 @@ layout: manual
 | 
			
		||||
| Name | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
{{#each args}}
 | 
			
		||||
| `{{name}}` | `{{type_}}` | {{description}} | {{#if required}}Yes{{else}}No{{/if}} |
 | 
			
		||||
| `{{name}}` | `{{type_}}` | {{{description}}} | {{#if required}}Yes{{else}}No{{/if}} |
 | 
			
		||||
{{/each}}
 | 
			
		||||
{{/if}}
 | 
			
		||||
 | 
			
		||||
{{#if return_value}}
 | 
			
		||||
### Returns
 | 
			
		||||
 | 
			
		||||
`{{return_value.type_}}` {{#if return_value.description}}- {{return_value.description}}{{/if}}
 | 
			
		||||
`{{return_value.type_}}` {{#if return_value.description}}- {{{return_value.description}}}{{/if}}
 | 
			
		||||
 | 
			
		||||
{{/if}}
 | 
			
		||||
 | 
			
		||||
@ -51,7 +51,7 @@ layout: manual
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
{{#unless @root.is_utilities}}
 | 
			
		||||

 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
{{/unless}}
 | 
			
		||||
{{/each}}
 | 
			
		||||
 | 
			
		||||
@ -8,6 +8,6 @@
 | 
			
		||||
| Property | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
{{#each properties}}
 | 
			
		||||
| `{{@key}}` | {{~ > propertyType this ~}} | {{this.description}} | {{#if (lookup ../required @key)}}Yes{{else}}No{{/if}} |
 | 
			
		||||
| `{{@key}}` | {{~ > propertyType this ~}} | {{{this.description}}} | {{#if (lookup ../required @key)}}Yes{{else}}No{{/if}} |
 | 
			
		||||
{{/each}}
 | 
			
		||||
{{/if}}
 | 
			
		||||
 | 
			
		||||
@ -1,5 +1,5 @@
 | 
			
		||||
{{#if description}}
 | 
			
		||||
{{description}}
 | 
			
		||||
{{{description}}}
 | 
			
		||||
{{/if}}
 | 
			
		||||
 | 
			
		||||
{{#if $ref}}
 | 
			
		||||
@ -64,7 +64,7 @@
 | 
			
		||||
 | 
			
		||||
{{#each examples}}
 | 
			
		||||
```json
 | 
			
		||||
{{json this}}
 | 
			
		||||
{{{json this}}}
 | 
			
		||||
```
 | 
			
		||||
{{/each}}
 | 
			
		||||
{{/if}}
 | 
			
		||||
 | 
			
		||||
		Reference in New Issue
	
	Block a user