Update fn syntax in KCL Types doc (#4640)

* update fn syntax

* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest-8-cores)

* Trigger CI

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jonathan Tran <jonnytran@gmail.com>
This commit is contained in:
Greg Sweeney
2024-12-03 13:17:02 -05:00
committed by GitHub
parent 5ae1aecd74
commit 9c47ac5b57
2 changed files with 8 additions and 3 deletions

View File

@ -54,7 +54,7 @@ We also have support for defining your own functions. Functions can take in any
type of argument. Below is an example of the syntax: type of argument. Below is an example of the syntax:
``` ```
fn myFn = (x) => { fn myFn(x) {
return x return x
} }
``` ```
@ -118,7 +118,7 @@ use the tag `rectangleSegmentA001` in any function or expression in the file.
However if the code was written like this: However if the code was written like this:
``` ```
fn rect = (origin) => { fn rect(origin) {
return startSketchOn('XZ') return startSketchOn('XZ')
|> startProfileAt(origin, %) |> startProfileAt(origin, %)
|> angledLine([0, 191.26], %, $rectangleSegmentA001) |> angledLine([0, 191.26], %, $rectangleSegmentA001)
@ -146,7 +146,7 @@ Tags are accessible through the sketch group they are declared in.
For example the following code works. For example the following code works.
``` ```
fn rect = (origin) => { fn rect(origin) {
return startSketchOn('XZ') return startSketchOn('XZ')
|> startProfileAt(origin, %) |> startProfileAt(origin, %)
|> angledLine([0, 191.26], %, $rectangleSegmentA001) |> angledLine([0, 191.26], %, $rectangleSegmentA001)

View File

@ -149,6 +149,11 @@
"title": "Tire", "title": "Tire",
"description": "A tire is a critical component of a vehicle that provides the necessary traction and grip between the car and the road. It supports the vehicle's weight and absorbs shocks from road irregularities." "description": "A tire is a critical component of a vehicle that provides the necessary traction and grip between the car and the road. It supports the vehicle's weight and absorbs shocks from road irregularities."
}, },
{
"file": "wall-e.kcl",
"title": "WALL-E",
"description": "An inquisitive trash compacting robot imagined by Disney Pixar Animation Studios"
},
{ {
"file": "washer.kcl", "file": "washer.kcl",
"title": "Washer", "title": "Washer",