Stale docstring: load_workspace says 'tmuxp does not allow appending'

Open
#1,027 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
cli, documentation

Research direction

Open src/tmuxp/cli/load.py around lines 574-577 and review the surrounding load_workspace documentation and session-exists options. Replace the stale statement with an accurate description of the default, --append, and --here modes, then verify the docstring clearly matches the behavior described in the issue.

Written by the indexing model from the issue text.

Description

Documentation Bug

The load_workspace docstring in src/tmuxp/cli/load.py (lines 574-577) says:

Currently, tmuxp does not allow appending a workspace / incremental building on top of a current session (pull requests are welcome!).

This is no longer accurate:

  • --append has been supported for some time (adds windows to the current attached session)
  • --here was added on the parity branch (reuses the current window for the first workspace window)
Fix

Remove or replace the stale text with an accurate description of the three session-exists modes:

  1. Default — prompts to reattach to the existing session
  2. --append — adds windows from the workspace to the current attached session
  3. --here — reuses the current window for the first workspace window and renames the session
Files
  • src/tmuxp/cli/load.py lines 574-577
Dominant language
Python
Stars
4.6k
Forks
248
Avg merge
2h 13m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tmux-python/tmuxp

All issues in tmux-python/tmuxp

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.