Skip to content

Commit 8f7ef49

Browse files
committed
Update docs
1 parent 859243b commit 8f7ef49

File tree

7 files changed

+73
-0
lines changed

7 files changed

+73
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "cutStrategy::automatic"
3+
subtitle: "Constant in cutStrategy"
4+
excerpt: "Try the fast but simple Basic strategy, and if that fails, try the slow and complex CSG strategy."
5+
layout: manual
6+
---
7+
8+
Try the fast but simple Basic strategy, and if that fails, try the slow and complex CSG strategy.
9+
10+
```kcl
11+
cutStrategy::automatic: string = "automatic"
12+
```
13+
14+
15+
16+
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "cutStrategy::basic"
3+
subtitle: "Constant in cutStrategy"
4+
excerpt: "The basic strategy is fastest, but it can't handle complicated cases (like chamfering two edges that touch)."
5+
layout: manual
6+
---
7+
8+
The basic strategy is fastest, but it can't handle complicated cases (like chamfering two edges that touch).
9+
10+
```kcl
11+
cutStrategy::basic: string = "basic"
12+
```
13+
14+
15+
16+
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "cutStrategy::csg"
3+
subtitle: "Constant in cutStrategy"
4+
excerpt: "The CSG strategy is slowest, but it can handle complex cases (like chamfering two edges that touch)."
5+
layout: manual
6+
---
7+
8+
The CSG strategy is slowest, but it can handle complex cases (like chamfering two edges that touch).
9+
10+
```kcl
11+
cutStrategy::csg: string = "csg"
12+
```
13+
14+
15+
16+

docs/kcl-std/functions/std-solid-fillet.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ fillet(
1414
tags: [Edge; 1+],
1515
tolerance?: number(Length),
1616
tag?: tag,
17+
strategy?: string,
1718
): Solid
1819
```
1920

@@ -30,6 +31,7 @@ will smoothly blend the transition.
3031
| `tags` | [`[Edge; 1+]`](/docs/kcl-std/types/std-types-Edge) | The paths you want to fillet | Yes |
3132
| `tolerance` | `number(Length)` | The tolerance for this fillet | No |
3233
| [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Create a new tag which refers to this fillet | No |
34+
| `strategy` | [`string`](/docs/kcl-std/types/std-types-string) | Which strategy should be used to perform this chamfer? | No |
3335

3436
### Returns
3537

docs/kcl-std/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,10 @@ layout: manual
124124
* [`Y`](/docs/kcl-std/consts/std-Y)
125125
* [`YZ`](/docs/kcl-std/consts/std-YZ)
126126
* [`Z`](/docs/kcl-std/consts/std-Z)
127+
* [**std::cutStrategy**](/docs/kcl-std/modules/std-cutStrategy)
128+
* [`cutStrategy::automatic`](/docs/kcl-std/consts/std-cutStrategy-automatic)
129+
* [`cutStrategy::basic`](/docs/kcl-std/consts/std-cutStrategy-basic)
130+
* [`cutStrategy::csg`](/docs/kcl-std/consts/std-cutStrategy-csg)
127131
* [**std::math**](/docs/kcl-std/modules/std-math)
128132
* [`E`](/docs/kcl-std/consts/std-math-E)
129133
* [`PI`](/docs/kcl-std/consts/std-math-PI)
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "cutStrategy"
3+
subtitle: "Module in std"
4+
excerpt: ""
5+
layout: manual
6+
---
7+
8+
9+
10+
11+
12+
13+
## Functions and constants
14+
15+
* [`cutStrategy::automatic`](/docs/kcl-std/consts/std-cutStrategy-automatic)
16+
* [`cutStrategy::basic`](/docs/kcl-std/consts/std-cutStrategy-basic)
17+
* [`cutStrategy::csg`](/docs/kcl-std/consts/std-cutStrategy-csg)
18+

docs/kcl-std/modules/std.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Contains frequently used constants, functions for interacting with the KittyCAD
1212
## Modules
1313

1414
* [`array`](/docs/kcl-std/modules/std-array)
15+
* [`cutStrategy::cutStrategy`](/docs/kcl-std/modules/std-cutStrategy)
1516
* [`math`](/docs/kcl-std/modules/std-math)
1617
* [`sketch`](/docs/kcl-std/modules/std-sketch)
1718
* [`solid`](/docs/kcl-std/modules/std-solid)

0 commit comments

Comments
 (0)