Repository navigation
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #785 +/- ##
=======================================
Coverage 52.37% 52.37%
=======================================
Files 26 26
Lines 3729 3729
Branches 747 747
=======================================
Hits 1953 1953
Misses 1472 1472
Partials 304 304 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
why: The Server page opened with a hierarchy list and one sentence, so finding a member meant scanning all of them. It also never said that an empty sessions, clients, or attached_sessions list can mean tmux is unreachable. what: - Describe what a Server addresses, when it starts tmux, and that each list read runs a tmux command - Add a "What is on here" overview that groups every public member under a bold lead-in, linked with :meth: and :attr:, and ends on cmd - Point at is_alive and raise_if_dead to tell an empty list from a missing server - Add two Examples doctests: get with default=None, and an idle server reading as empty
why: The unreleased entry did not record that the Server reference now opens with a grouped member overview and states how an empty list reads when tmux is unreachable. what: - Note the Server overview under Documentation
This branch has not been 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
1 participant
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.
The
ServerAPI reference lists every member without saying which to reach for. This opens theServerdocstring with what a server is, then adds a "What is on here" overview that groups each member by purpose, every name linked. The groups are connecting, finding one thing, listing everything, querying and traversal, changing things, options and hooks, everything else tmux keeps, and calls that need an attached terminal. The same structure is used on the Rust Server reference.The overview states behaviour as it is today, each point checked on tmux 3.7d against throwaway sockets:
sessions,clientsandattached_sessionsread as empty on any tmux failure. The overview points tois_aliveandraise_if_deadfor telling that apart from an empty server.kill_sessionmatches a bare name as a prefix;=namematches exactly.start_serveron a dead socket leaves no server running, because tmux exits again under the defaultexit-empty.LibTmuxExceptionwithout an attached client.Two doctests are added:
sessions.get(..., default=None), and an idle server whosesessionsreads[]whileis_alive()is False.Validation:
ruff checkandruff format --checkpass.mypypasses.server.pydoctests pass (42), and the fullpytestsuite passes (1453 passed, 3 skipped).just build-docsreports 0 warnings.Servermember linked.