Repository navigation
Conversation
…and Pane
why: Server's reference page shows a capability directory, but Session,
Window and Pane have no class doc, 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, changing,
options and environment, formats
- Window: finding, looking inside, splitting and arranging, changing,
options and formats
- Pane: finding, sending input, reading output, splitting and arranging,
copy mode and pipes, changing, options and formats
- Match the Server directory: bold-led rows, then bullet lists of YARD
{#method} references
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 in Server's shape, with YARD
{#method}references.Changes
gems/libtmux/lib/libtmux/entity.rb,Session: Finding the session; Looking inside a session; Creating a window; Changing things; Options, hooks and environment; Expanding a format.gems/libtmux/lib/libtmux/entity.rb,Window: Finding the window; Looking inside a window; Splitting and arranging; Changing things; Options, hooks and formats.gems/libtmux/lib/libtmux/entity.rb,Pane: Finding the pane; Sending input; Reading output; Splitting and arranging; Copy mode, buffers and pipes; Changing things; Options, hooks and formats.Review notes
Test plan
parseApiProseandgroupDirectoryfrom libtmux/docs, after this port's doc parser) folds each new doc comment into a directoryyard stats --private --protectedreports no warnings