ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve docs for x/yLine and x/yLineTo (#3285)

Browse Source 
* Improve docs for xLineTo and yLineTo

* Improve docs for xLine and yLine
This commit is contained in:
Adam Chalmers
2024-08-05 23:26:19 -05:00
committed by GitHub
parent 1c778bf373
commit d27afb8c74
6 changed files with 24 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/kcl/std.json
View File

@ -223491,7 +223491,7 @@
},
{
"name": "xLine",
"summary": "Draw a line on the x-axis.",
"summary": "Draw a line parallel to the X-axis, with the given length.",
"description": "",
"tags": [],
"args": [
@ -230125,8 +230125,8 @@
},
{
"name": "xLineTo",
"summary": "Draw a line to a point on the x-axis.",
"description": "",
"summary": "Draw a line parallel to the X axis, that ends at the given X.",
"description": "E.g. if the previous line ended at (1, 1), then xLineTo(4) draws a line from (1, 1) to (4, 1)",
"tags": [],
"args": [
{
@ -236759,7 +236759,7 @@
},
{
"name": "yLine",
"summary": "Draw a line on the y-axis.",
"summary": "Draw a line parallel to the Y-axis, with the given length.",
"description": "",
"tags": [],
"args": [
@ -243393,8 +243393,8 @@
},
{
"name": "yLineTo",
"summary": "Draw a line to a point on the y-axis.",
"description": "",
"summary": "Draw a line parallel to the Y axis, that ends at the given Y.",
"description": "E.g. if the previous line ended at (1, 1), then yLineTo(4) draws a line from (1, 1) to (1, 4)",
"tags": [],
"args": [
{

4
docs/kcl/xLine.md
View File

@ -1,10 +1,10 @@
---
title: "xLine"
excerpt: "Draw a line on the x-axis."
excerpt: "Draw a line parallel to the X-axis, with the given length."
layout: manual
---
Draw a line on the x-axis.
Draw a line parallel to the X-axis, with the given length.

6
docs/kcl/xLineTo.md
View File

@ -1,12 +1,12 @@
---
title: "xLineTo"
excerpt: "Draw a line to a point on the x-axis."
excerpt: "Draw a line parallel to the X axis, that ends at the given X."
layout: manual
---
Draw a line to a point on the x-axis.
Draw a line parallel to the X axis, that ends at the given X.
E.g. if the previous line ended at (1, 1), then xLineTo(4) draws a line from (1, 1) to (4, 1)
```js
xLineTo(to: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGroup

4
docs/kcl/yLine.md
View File

@ -1,10 +1,10 @@
---
title: "yLine"
excerpt: "Draw a line on the y-axis."
excerpt: "Draw a line parallel to the Y-axis, with the given length."
layout: manual
---
Draw a line on the y-axis.
Draw a line parallel to the Y-axis, with the given length.

6
docs/kcl/yLineTo.md
View File

@ -1,12 +1,12 @@
---
title: "yLineTo"
excerpt: "Draw a line to a point on the y-axis."
excerpt: "Draw a line parallel to the Y axis, that ends at the given Y."
layout: manual
---
Draw a line to a point on the y-axis.
Draw a line parallel to the Y axis, that ends at the given Y.
E.g. if the previous line ended at (1, 1), then yLineTo(4) draws a line from (1, 1) to (1, 4)
```js
yLineTo(to: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGroup

12
src/wasm-lib/kcl/src/std/sketch.rs
View File

@ -168,7 +168,9 @@ pub async fn x_line_to(args: Args) -> Result<MemoryItem, KclError> {
Ok(MemoryItem::SketchGroup(new_sketch_group))
}
/// Draw a line to a point on the x-axis.
/// Draw a line parallel to the X axis, that ends at the given X.
/// E.g. if the previous line ended at (1, 1),
/// then xLineTo(4) draws a line from (1, 1) to (4, 1)
///
/// ```no_run
/// const exampleSketch = startSketchOn('XZ')
@ -214,7 +216,9 @@ pub async fn y_line_to(args: Args) -> Result<MemoryItem, KclError> {
Ok(MemoryItem::SketchGroup(new_sketch_group))
}
/// Draw a line to a point on the y-axis.
/// Draw a line parallel to the Y axis, that ends at the given Y.
/// E.g. if the previous line ended at (1, 1),
/// then yLineTo(4) draws a line from (1, 1) to (1, 4)
///
/// ```no_run
/// const exampleSketch = startSketchOn("XZ")
@ -336,7 +340,7 @@ pub async fn x_line(args: Args) -> Result<MemoryItem, KclError> {
Ok(MemoryItem::SketchGroup(new_sketch_group))
}
/// Draw a line on the x-axis.
/// Draw a line parallel to the X-axis, with the given length.
///
/// ```no_run
/// const exampleSketch = startSketchOn('XZ')
@ -378,7 +382,7 @@ pub async fn y_line(args: Args) -> Result<MemoryItem, KclError> {
Ok(MemoryItem::SketchGroup(new_sketch_group))
}
/// Draw a line on the y-axis.
/// Draw a line parallel to the Y-axis, with the given length.
///
/// ```no_run
/// const exampleSketch = startSketchOn('XZ')