Skip to content

Commit f78ee24

Browse files
authored
Update customization.md
1 parent 37ba96e commit f78ee24

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

packages/cursorless-org-docs/src/docs/user/customization.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -211,27 +211,27 @@ _NOTE that this feature is experimental. Not as thoroughly tested as the rest of
211211

212212
`user.cursorless_custom_command(command: string, *args)`
213213

214-
Run a custom Cursorless command by parsing the specified command string.
214+
Run a custom Cursorless command by parsing the specified command string. Supports a subset of the Cursorless grammar, with **default** spoken forms (not your custom spoken forms). See https://www.cursorless.org/custom-command-railroad to see the subset of our grammar that we support today.
215215

216216
- Utilizes default Cursorless spoken forms in the command string.
217-
- Optional target arguments can be interpolated in the command string.
217+
- Optional target arguments can be interpolated in the command string. (see examples below)
218218

219219
#### Examples
220220

221-
`"scratch"` => `"chuck block"`
221+
In order to map `"scratch"` to perform `"chuck block"`:
222222

223223
```talon
224224
scratch: user.cursorless_custom_command("chuck block")
225225
```
226226

227-
`"scratch air"` => `"chuck block air"`
227+
To map `"scratch air"` => `"chuck block air"`
228228

229229
```talon
230230
scratch <user.cursorless_target>:
231231
user.cursorless_custom_command("chuck block <target>", cursorless_target)
232232
```
233233

234-
`"combine air plus bat"` => `"bring block air after bat"`
234+
To map `"combine air plus bat"` => `"bring block air after bat"`
235235

236236
```talon
237237
combine <user.cursorless_target> plus <user.cursorless_target>:

0 commit comments

Comments
 (0)