Repository navigation
Conversation
…and Pane why: Server's reference page shows a capability directory, but Session, Window and Pane carry one-line descriptions, so a reader arriving with a job has no way in to the methods that do it. what: - Session: finding, looking inside, creating a window, renaming and navigating, options and environment, terminal, removing - Window: finding, looking inside, arranging, placing in sessions, changing, options and hooks - Pane: finding, sending input, reading output, splitting and arranging, copy mode and buffers, changing, options and hooks - Match the Server directory: bold-led rows, each followed by a paragraph of code-span names
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
libtmux.Server opens with a task directory on libtmux.org; Session, Window and Pane do not. This adds them above each
---@class, in Server's shape, with names in code spans.Changes
lua/libtmux/_internal/entity.lua,Session: Finding the session; Looking inside a session; Creating a window; Renaming and moving between windows; Options, hooks and environment; Things that need a terminal; Removing the session.lua/libtmux/_internal/entity.lua,Window: Finding the window; Looking inside a window; Arranging; Placing in sessions; Changing things; Options and hooks.lua/libtmux/_internal/entity.lua,Pane: Finding the pane; Sending input; Reading output; Splitting and arranging; Copy mode and buffers; Changing things; Options and hooks.Test plan
parseApiProseandgroupDirectoryfrom libtmux/docs, after this port's doc parser) folds each new doc comment into a directorystylua --checkpasses, the file loads under Lua 5.5, and no line passes 100 columns