Skip to content

Correct library setup and terminal documentation examples - #797

Open
tony wants to merge 5 commits into
masterfrom
docs-audit-000
Open

tony wants to merge 5 commits into
masterfrom
docs-audit-000

Conversation

@tony

@tony tony commented Oct 29, 2026

Copy link
Copy Markdown
Member

Install libtmux into the Python environment that imports it, and use a complete first-use example whose server and temporary socket are cleaned up together. Terminal recipes wait for complete printed marker lines, use monotonic deadlines, and explain the limits of completion markers.

The quickstart and reference pages describe fixture injection, split defaults, shell history, literal keys, active deprecations and configured CI targets. Release guidance links the canonical contributor policies. Existing navigation and historical release entries are preserved.

Validation:

  • Live-tmux doctests for affected documentation passed. The current standalone README example also passed without fixture injection, with server shutdown and temporary-directory removal verified.
  • Strict Sphinx build, Ruff format/lint and mypy passed.
  • Positive and echo-only negative controls checked the completion predicates. Navigation checks preserve headings and anchors; historical release bodies and placeholders match their original bytes.

Two existing concerns remain deferred: the skipped shell-prompt capture illustration in the README, and the legacy docs requirements include whose external consumers are unknown.

tony added 5 commits October 28, 2026 19:51
why: Library users need imports in their active Python environment.

what:
- Replace application-only installation routes with pip and uv
- Show valid PEP 621 dependencies and tested-series bounds
- Keep development installation in the quickstart
why: Repository fixtures hid prerequisites and cleanup ownership.

what:
- Add a fixture-free README example on a temporary socket
- Explain requested fixtures and downstream doctest setup
- Bound server context cleanup to resources the caller owns
why: Echoed command text could falsely signal completed work.

what:
- Match complete marker lines on fresh output lines
- Use monotonic bounds and predicate waits in examples
- Distinguish progress, completion and process exit status
why: Examples need to match tmux defaults and shell boundaries.

what:
- Document explicit split attachment and the default prefix
- Qualify history suppression and literal key handling
why: Duplicated guides drifted from the project's actual contracts.

what:
- Link the authoritative release and changelog policies
- Describe configured CI targets and current deprecations
- Correct the API landing-page link
@codecov

codecov Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.37%. Comparing base (0813d07) to head (b62fca1).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #797      +/-   ##
==========================================
- Coverage   52.45%   52.37%   -0.09%     
==========================================
  Files          26       26              
  Lines        3729     3729              
  Branches      747      747              
==========================================
- Hits         1956     1953       -3     
- Misses       1469     1472       +3     
  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.

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