diff --git a/docs/kcl/std.json b/docs/kcl/std.json index 91252b8cf..4b634f5f2 100644 --- a/docs/kcl/std.json +++ b/docs/kcl/std.json @@ -514,10 +514,18 @@ ], "returnValue": { "name": "", - "type": "number", + "type": "Angle", "schema": { - "type": "number", - "format": "double" + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } }, "required": true }, @@ -983,10 +991,18 @@ ], "returnValue": { "name": "", - "type": "number", + "type": "Angle", "schema": { - "type": "number", - "format": "double" + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } }, "required": true }, @@ -1016,8 +1032,16 @@ "properties": { "angle": { "description": "The angle of the line.", - "type": "number", - "format": "double" + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } }, "length": { "description": "The length of the line.", @@ -1033,10 +1057,24 @@ { "description": "An angle and length.", "type": "array", - "items": { - "type": "number", - "format": "double" - }, + "items": [ + { + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } + }, + { + "type": "number", + "format": "double" + } + ], "maxItems": 2, "minItems": 2 } @@ -1937,8 +1975,16 @@ "properties": { "angle": { "description": "The angle of the line.", - "type": "number", - "format": "double" + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } }, "length": { "description": "The length of the line.", @@ -1954,10 +2000,24 @@ { "description": "An angle and length.", "type": "array", - "items": { - "type": "number", - "format": "double" - }, + "items": [ + { + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } + }, + { + "type": "number", + "format": "double" + } + ], "maxItems": 2, "minItems": 2 } @@ -2858,8 +2918,16 @@ "properties": { "angle": { "description": "The angle of the line.", - "type": "number", - "format": "double" + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } }, "length": { "description": "The length of the line.", @@ -2875,10 +2943,24 @@ { "description": "An angle and length.", "type": "array", - "items": { - "type": "number", - "format": "double" - }, + "items": [ + { + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } + }, + { + "type": "number", + "format": "double" + } + ], "maxItems": 2, "minItems": 2 } @@ -3775,8 +3857,16 @@ "properties": { "angle": { "description": "The angle of the line.", - "type": "number", - "format": "double" + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } }, "intersectTag": { "description": "The tag of the line to intersect with.", @@ -4690,8 +4780,16 @@ "properties": { "angle": { "description": "The angle of the line.", - "type": "number", - "format": "double" + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } }, "tag": { "description": "The tag.", @@ -4707,10 +4805,24 @@ { "description": "An angle and point to draw to.", "type": "array", - "items": { - "type": "number", - "format": "double" - }, + "items": [ + { + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } + }, + { + "type": "number", + "format": "double" + } + ], "maxItems": 2, "minItems": 2 } @@ -5611,8 +5723,16 @@ "properties": { "angle": { "description": "The angle of the line.", - "type": "number", - "format": "double" + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } }, "tag": { "description": "The tag.", @@ -5628,10 +5748,24 @@ { "description": "An angle and point to draw to.", "type": "array", - "items": { - "type": "number", - "format": "double" - }, + "items": [ + { + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } + }, + { + "type": "number", + "format": "double" + } + ], "maxItems": 2, "minItems": 2 } @@ -13889,10 +14023,18 @@ ], "returnValue": { "name": "", - "type": "number", + "type": "Angle", "schema": { - "type": "number", - "format": "double" + "type": "object", + "required": [ + "degrees" + ], + "properties": { + "degrees": { + "type": "number", + "format": "double" + } + } }, "required": true }, diff --git a/docs/kcl/std.md b/docs/kcl/std.md index b9c836e23..2c1adffec 100644 --- a/docs/kcl/std.md +++ b/docs/kcl/std.md @@ -106,7 +106,7 @@ Returns the angle to match the given length for x. ``` -angleToMatchLengthX(segment_name: string, to: number, sketch_group: SketchGroup) -> number +angleToMatchLengthX(segment_name: string, to: number, sketch_group: SketchGroup) -> Angle ``` #### Arguments @@ -179,7 +179,12 @@ angleToMatchLengthX(segment_name: string, to: number, sketch_group: SketchGroup) #### Returns -* `number` +* `Angle` +``` +{ + degrees: number, +} +``` @@ -190,7 +195,7 @@ Returns the angle to match the given length for y. ``` -angleToMatchLengthY(segment_name: string, to: number, sketch_group: SketchGroup) -> number +angleToMatchLengthY(segment_name: string, to: number, sketch_group: SketchGroup) -> Angle ``` #### Arguments @@ -263,7 +268,12 @@ angleToMatchLengthY(segment_name: string, to: number, sketch_group: SketchGroup) #### Returns -* `number` +* `Angle` +``` +{ + degrees: number, +} +``` @@ -283,13 +293,15 @@ angledLine(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup ``` { // The angle of the line. - angle: number, + angle: { + degrees: number, +}, // The length of the line. length: number, // The tag. tag: string, } | -[number] +string ``` * `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. ``` @@ -439,13 +451,15 @@ angledLineOfXLength(data: AngledLineData, sketch_group: SketchGroup) -> SketchGr ``` { // The angle of the line. - angle: number, + angle: { + degrees: number, +}, // The length of the line. length: number, // The tag. tag: string, } | -[number] +string ``` * `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. ``` @@ -595,13 +609,15 @@ angledLineOfYLength(data: AngledLineData, sketch_group: SketchGroup) -> SketchGr ``` { // The angle of the line. - angle: number, + angle: { + degrees: number, +}, // The length of the line. length: number, // The tag. tag: string, } | -[number] +string ``` * `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. ``` @@ -751,7 +767,9 @@ angledLineThatIntersects(data: AngeledLineThatIntersectsData, sketch_group: Sket ``` { // The angle of the line. - angle: number, + angle: { + degrees: number, +}, // The tag of the line to intersect with. intersectTag: string, // The offset from the intersecting line. @@ -908,13 +926,15 @@ angledLineToX(data: AngledLineToData, sketch_group: SketchGroup) -> SketchGroup ``` { // The angle of the line. - angle: number, + angle: { + degrees: number, +}, // The tag. tag: string, // The point to draw to. to: number, } | -[number] +string ``` * `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. ``` @@ -1064,13 +1084,15 @@ angledLineToY(data: AngledLineToData, sketch_group: SketchGroup) -> SketchGroup ``` { // The angle of the line. - angle: number, + angle: { + degrees: number, +}, // The tag. tag: string, // The point to draw to. to: number, } | -[number] +string ``` * `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. ``` @@ -2680,7 +2702,7 @@ Returns the angle of the segment. ``` -segAng(segment_name: string, sketch_group: SketchGroup) -> number +segAng(segment_name: string, sketch_group: SketchGroup) -> Angle ``` #### Arguments @@ -2752,7 +2774,12 @@ segAng(segment_name: string, sketch_group: SketchGroup) -> number #### Returns -* `number` +* `Angle` +``` +{ + degrees: number, +} +```