Skip to content

Docs: Refresh native tmux API citations - #774

Open
tony wants to merge 5 commits into
masterfrom
docs-p0-manual-citations-20261014
Open

tony wants to merge 5 commits into
masterfrom
docs-p0-manual-citations-20261014

Conversation

@tony

@tony tony commented Oct 15, 2026 •

Copy link
Copy Markdown
Member

The object reference citations mix 2018 access dates, long quoted text and missing native command links. Refresh Server, Session, Window, Pane and Client attributions against tmux 3.7c, retaining accurate quotations and existing citation fragments. Link the native manual sections and relevant commands; correct Client's show-messages explanation to describe server messages or information.

Preserve the three existing QueryList exception/default-scope descriptions already displayed in the shared reference by retaining their source-owned documentation commits.

Independent review verified the pinned upstream manual and command source, all five native citation anchors and 16 unique link targets. Fresh Sphinx output from the final source builds without warnings and preserves all 25 citation links; Ruff passes. Executable AST and documented example source, expected output and options match the prior reference source. Hosted native testing is reported separately in the checks.

Shared-site extraction, generated exports and publication are being integrated in libtmux/docs#145. This change does not publish a Python package.

tony added 2 commits October 14, 2026 20:42
why: Readers need versioned tmux command references beside the object
descriptions. The Client citation must quote real upstream text.

what:
- Link all five object citations to tmux 3.7c and relevant commands
- Preserve accurate quotations, citation labels, and OpenBSD attribution
- Replace the unsupported Client quotation with sourced text and links
- Cite pinned upstream source rather than mechanically redating access
why: tmux stores server messages in a global log. Attributing that
output to one client misstates the command's scope.

what:
- Describe show-messages as reporting server messages or information
- Preserve its versioned link and the existing citation identity
@codecov

codecov Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.45%. Comparing base (9fdd083) to head (8e0ce38).
⚠️ Report is 8 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #774   +/-   ##
=======================================
  Coverage   52.45%   52.45%           
=======================================
  Files          26       26           
  Lines        3729     3729           
  Branches      747      747           
=======================================
  Hits         1956     1956           
  Misses       1469     1469           
  Partials      304      304           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tony added 3 commits October 14, 2026 21:33
Both reached the API reference as a name and a base class with no sentence.
One says a primary key was never set; the other that a filter named a lookup
that does not exist, which is what a mistyped keyword arrives as.
It is the default value of every `scope` parameter and appeared in the API
reference as a name with a `...` body. The distinction worth stating is that
it is not the same as passing no scope: tmux resolves the option itself.
why: Restoring the source description already displayed in the API reference leaves an extra blank line rejected by the current formatter.

what: Remove that blank line without changing the description or executable syntax.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant