Skip to content

Commit 46e8bc0

Browse files
committed
docs(api): Note these APIs are unstable
1 parent 3ee06c5 commit 46e8bc0

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/api.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@
33
# API Reference
44

55
:::{seealso}
6-
7-
See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart <libtmux:quickstart>` to see how you can control tmux via python API calls.
8-
6+
See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart <libtmux:quickstart>` to see how you can control
7+
tmux via python API calls.
98
:::
109

1110
```{module} tmuxp
@@ -14,6 +13,11 @@ See {ref}`libtmux's API <libtmux:api>` and {ref}`Quickstart <libtmux:quickstart>
1413

1514
## Internals
1615

16+
:::{warning}
17+
These APIs are purely internal not covered by versioning policies, they can and will break between versions.
18+
If you need an internal API stabilized please [file an issue](https://github.com/tmux-python/tmuxp/issues).
19+
:::
20+
1721
```{eval-rst}
1822
.. automethod:: tmuxp.util.run_before_script
1923
```

0 commit comments

Comments
 (0)