Skip to content

Commit 8c5e1ad

Browse files
committed
formats(fix[docs]): scope "reference-only" claim to *_FORMATS lists
why: The module docstring added in 4f2ae6e said "not imported or consumed at runtime" — but FORMAT_SEPARATOR is imported by neo, pane, and session at runtime. The blanket claim was inaccurate. what: - Scope the reference-only note to *_FORMATS lists explicitly - Add a sentence naming FORMAT_SEPARATOR as the runtime-used constant
1 parent b85509a commit 8c5e1ad

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

src/libtmux/formats.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
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.
6+
:data:`FORMAT_SEPARATOR` is used at runtime by ``neo``, ``pane``, and
7+
``session``. The ``*_FORMATS`` lists (``SESSION_FORMATS``,
8+
``WINDOW_FORMATS``, ``PANE_FORMATS``, etc.) are **reference documentation
9+
only** — they are not imported or consumed at runtime. The active format
10+
mechanism is :class:`libtmux.neo.Obj`, whose dataclass fields are
11+
introspected by :func:`libtmux.neo.get_output_format` to build tmux format
12+
strings dynamically.
1113
1214
For reference: https://github.com/tmux/tmux/blob/master/format.c
1315

0 commit comments

Comments
 (0)