Skip to content

Commit d3c0c87

Browse files
committed
workspace/builder(docs[pane-readiness]): Document shell-skip heuristic scope
why: The readiness skip for panes with shell/window_shell was undocumented, making it unclear to future maintainers why pane_shell is None is the check. what: - Add comment explaining that shell/window_shell runs a command launcher, not an interactive shell, so there is no prompt to wait for
1 parent 0139018 commit d3c0c87

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

src/tmuxp/workspace/builder.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -564,6 +564,10 @@ def get_pane_shell(
564564

565565
assert isinstance(pane, Pane)
566566

567+
# Skip readiness wait when a custom shell/command launcher is set.
568+
# The shell/window_shell key runs a command (e.g. "top", "sleep 999")
569+
# that replaces the default shell — the pane exits when the command
570+
# exits, so there is no interactive prompt to wait for.
567571
pane_shell = pane_config.get("shell", window_config.get("window_shell"))
568572
if pane_shell is None:
569573
_wait_for_pane_ready(pane)

0 commit comments

Comments
 (0)