Skip to content

Commit d93590f

Browse files
committed
docs(constants): Say what the default-scope sentinel means
It is the default value of every `scope` parameter and appeared in the API reference as a name with a `...` body. The distinction worth stating is that it is not the same as passing no scope: tmux resolves the option itself.
1 parent ac7fd2d commit d93590f

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

‎src/libtmux/constants.py‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,14 @@ class PaneDirection(enum.Enum):
5454

5555

5656
class _DefaultOptionScope:
57-
# Sentinel value for default scope
58-
...
57+
"""Sentinel meaning "whichever scope tmux would use".
58+
59+
Distinct from passing no scope at all: this is the default value of the
60+
``scope`` parameter, and a call carrying it sends no scope flag. tmux then
61+
resolves the option itself, which for a pane option means falling back to
62+
the window's and then to the global window options.
63+
"""
64+
5965

6066

6167
DEFAULT_OPTION_SCOPE: _DefaultOptionScope = _DefaultOptionScope()

0 commit comments

Comments
 (0)