Skip to content

Streamline and document direct commands #527

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

Jump to bottom
Merged
merged 28 commits into from
Feb 17, 2024
Merged

Streamline and document direct commands #527

merged 28 commits into from
Feb 17, 2024

Conversation

tony
Copy link
Member

@tony tony commented Feb 17, 2024 •
edited
Loading

Changes

Cleanups

  • .cmd: Streamline by:
    • using cmd: str as first position argument
    • Removing unused keyword arguments **kwargs

Renamings

  • Session.attached_window renamed to Session.active_window
    • Session.attached_window deprecated
  • Session.attached_pane renamed to Session.active_pane
    • Session.attached_pane deprecated
  • Window.attached_pane renamed to Window.active_pane
    • Window.attached_pane deprecated

Improvements

  • Server.attached_windows now users QueryList's .filter()

Documentation

  • Document .cmd in README and quickstart
  • Add doctests and improve docstrings to cmd() methods across:
    • Server.cmd
    • Session.cmd
    • Window.cmd
    • Pane.cmd

@tony tony force-pushed the run branch 5 times, most recently from dfaa717 to 635ff6d Compare February 17, 2024 10:44
@tony tony changed the title Docs(run): Emphasize you can run any command, contextually Streamline and document direct commands Feb 17, 2024
tony added 19 commits February 17, 2024 06:52
@tony
docs(README): Overhaul doctests
7552e3b
@tony
docs(quickstart): Add raw commands
5a86a95
@tony
docs(Server.cmd): Add examples
7547e9c
@tony
chore(Server.cmd): Accept cmd as first positional argument
e4a47c2
@tony
chore(Session.cmd): Accept cmd as first positional argument
8c297fc
@tony
Session(cmd): Remove **kwargs
2dd6331
@tony
Server(cmd): Remove **kwargs
a801351
@tony
Window(cmd): Remove **kwargs
c44225a
@tony
Pane(cmd): Remove **kwargs
20c4cd0
@tony
Server.attached_sessions: Simplify by using filter
d512f90
@tony
Session.attached_window: Use .filter
eb3bc27
@tony
feat: Rename Session.attached_window -> Session.active_window
9d95438 
Deprecate Session.attached_window
@tony
refactor(Session.active_window): Use renamed method
9c67ae6
@tony
Window.attached_pane: Use .filter
3b7aa9f
@tony
feat: Rename Window.attached_pane -> Window.active_pane
e35e3d9 
Deprecate Window.attached_pane
@tony
Session: Consolidate duplicate computed property (attached_pane)
bc4a971
@tony
feat: Rename Session.attached_pane -> Session.active_pane
5cede5a 
Deprecate Session.attached_pane
@tony
refactor({Window,Session}.active_pane): Use renamed method
d75d5ff
@tony
refactor!(tmux_cmd): Remove kwargs
01ab013
@tony tony merged commit b356b92 into master Feb 17, 2024
@tony tony deleted the run branch February 17, 2024 12:58
tony added a commit that referenced this pull request Feb 17, 2024
@tony
Tag v0.31.0 (command refactor #527)
af5b999
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@tony