Repository navigation
Docs(feat[readme]): Show how to read a window, session or pane again - #97
Merged
Merged
Conversation
tony
force-pushed
the
docs-readme-refresh
branch
from
November 7, 2026 14:56
e9b3b61 to
09efb09
Compare
why: Readers who know Python libtmux look for `.refresh()`. Ruby has no in-place refresh: a snapshot record is what tmux said when it was read, and `Entity#snapshot` reads the object again into a new record. The README did not say so. what: - Add a `Window#snapshot` section to the README that says a held record does not follow tmux, that Ruby reads again rather than refreshing in place, and links `Window#snapshot`, `Session#snapshot` and `Pane#snapshot` (`README.md`) - Add the `refresh` program, which renames a window and prints the held record's name and the fresh read's name, and register it with its `refresh/main` excerpt (`examples/refresh.rb`, `examples/manifest.json`)
tony
force-pushed
the
docs-readme-refresh
branch
from
November 7, 2026 18:42
09efb09 to
97fe1cf
Compare
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.
What
Adds a "
Window#snapshot: read one object again" section to the root README, after the snapshot queries. It says a record from a snapshot is what tmux said when it was read and a change to tmux does not reach it, that Ruby has no in-placerefreshlike Python libtmux's.refresh(), and thatWindow#snapshot(alsoSession#snapshot,Pane#snapshot) reads the object again into a new record while the one you hold stays as it was.The excerpt is the
refresh/mainregion of a newexamples/refresh.rb: it renames a window, then prints the held record's name (editor) and the fresh read's name (build). The program is registered inexamples/manifest.jsonas a program and as a snippet, andscripts/examples --writefilled the README block.Why
The maintainer asked for a plain refresh idiom in each port's README. Sibling PRs: libtmux/libtmux-ts#194, libtmux/libtmux-rs#137. Ruby's real idiom is
Entity#snapshot, so the section says so instead of inventing arefresh.Checks
scripts/examples --check: 29 programs, source excerpts current.scripts/check mid: 306 runs, 3874 assertions, 0 failures (includes the README block lint and example manifest tests).scripts/check packaging: 5 runs, 403 assertions, 0 failures (builds the gems and runs the programs from the installed artifacts).examples/refresh.rbmade the program fail withunexpected names; restored.libtmux-window-snapshot,libtmux-session-snapshotandlibtmux-pane-snapshotreference pages on libtmux.org return 200.Tool use: Claude Code, directed by the maintainer, wrote the change and ran the checks above.