Skip to content

Commit b85509a

Browse files
committed
formats(docs[PANE_FORMATS]): clarify lists are reference-only, not runtime
why: PANE_FORMATS and sibling constants are never imported at runtime; the live mechanism is neo.Obj.__dataclass_fields__ + get_output_format(). Without this docstring, the pane_title entry uncommented in this PR looks like dead code that should be removed. what: - Expand module docstring to state constants are reference documentation - Point future maintainers to neo.Obj and get_output_format()
1 parent 5539d96 commit b85509a

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

src/libtmux/formats.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
libtmux.formats
44
~~~~~~~~~~~~~~~
55
6+
These lists are **reference documentation only** — they are not imported
7+
or consumed at runtime. The active format mechanism is
8+
:class:`libtmux.neo.Obj`, whose dataclass fields are introspected by
9+
:func:`libtmux.neo.get_output_format` to build tmux format strings
10+
dynamically.
11+
612
For reference: https://github.com/tmux/tmux/blob/master/format.c
713
814
"""

0 commit comments

Comments
 (0)