Skip to content

Commit 5c55477

Browse files
committed
docs(CHANGES,examples): Note that enter and sleep is experimental
1 parent 6125686 commit 5c55477

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

docs/examples.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -328,14 +328,20 @@ This will add the `shell_command` to the bash history in the pane.
328328
329329
````
330330

331+
(enter)=
332+
331333
## Skip command execution
332334

333-
```{versionadded} 1.10.0b1
334-
`enter: false` option. Pane-level support.
335-
```
335+
See more at {ref}`enter`.
336+
337+
:::{note}
338+
339+
_Experimental setting_: behavior and api is subject to change until stable.
340+
341+
:::
336342

337-
```{versionadded} 1.10.0b3
338-
Support command-level skipping.
343+
```{versionadded} 1.10.0
344+
`enter: false` option. Pane-level support.
339345
```
340346

341347
Omit sending {kbd}`enter` to key commands. Equivalent to
@@ -377,14 +383,22 @@ Omit sending {kbd}`enter` to key commands. Equivalent to
377383
378384
````
379385

386+
(sleep)=
387+
380388
## Pausing commands
381389

382-
```{versionadded} 1.10.0b4
390+
:::{note}
391+
392+
_Experimental setting_: behavior and api is subject to change until stable.
393+
394+
:::
395+
396+
```{versionadded} 1.10.0
383397
`sleep_before` and `sleep_after` options added. Pane and command-level support.
384398
```
385399

386400
```{warning}
387-
This will delay loading as it runs synchronously for each pane. In future version asynchronous support, (i.e. [`asyncio`](asyncio)) will speed up this up.
401+
**Blocking.** This will delay loading as it runs synchronously for each pane as [`asyncio`](asyncio)) is not implemented yet.
388402
```
389403

390404
Omit sending {kbd}`enter` to key commands. Equivalent to having

0 commit comments

Comments
 (0)