Skip to content

Preview gp-sphinx#36 curated default-value rendering #668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tony wants to merge 1 commit into
base: master
Choose a base branch
from
+16 −2
Open

Preview gp-sphinx#36 curated default-value rendering #668

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions src/libtmux/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,25 @@ class PaneDirection(enum.Enum):


class _DefaultOptionScope:
# Sentinel value for default scope
...
"""Sentinel type for the ``scope=`` parameter's default value.

The lone instance :data:`DEFAULT_OPTION_SCOPE` is used as the
default for option-related helpers; receiving methods use ``is``
comparison against the sentinel to detect "no explicit scope was
passed" and infer the right scope from the bound object type.
"""


DEFAULT_OPTION_SCOPE: _DefaultOptionScope = _DefaultOptionScope()
"""Sentinel default for ``scope=`` parameters on option / hook helpers.

When ``scope is DEFAULT_OPTION_SCOPE`` the caller hasn't selected an
explicit :class:`OptionScope`; the receiving method
(:meth:`Pane._show_option`, :meth:`Server.show_options`, etc.)
infers the appropriate scope from the bound object type
(``Pane`` → ``OptionScope.Pane``, ``Server`` → ``OptionScope.Server``,
…).
"""


class OptionScope(enum.Enum):
Expand Down
Loading