Skip to content

Commit 41e29b0

Browse files
committed
docs(API): Document internal constants
1 parent 95631b4 commit 41e29b0

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

docs/internals/constants.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Internal Constants - `libtmux._internal.constants`
2+
3+
:::{warning}
4+
Be careful with these! These constants are private, internal as they're **not** covered by version policies. They can break or be removed between minor versions!
5+
6+
If you need a data structure here made public or stabilized please [file an issue](https://github.com/tmux-python/libtmux/issues).
7+
:::
8+
9+
```{eval-rst}
10+
.. automodule:: libtmux._internal.constants
11+
:members:
12+
:undoc-members:
13+
:inherited-members:
14+
:show-inheritance:
15+
```

docs/internals/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ If you need an internal API stabilized please [file an issue](https://github.com
1111
```{toctree}
1212
dataclasses
1313
query_list
14+
constants
1415
```
1516

1617
## Environmental variables

0 commit comments

Comments
 (0)