Skip to content

docs(README) Overhaul README #592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
tony wants to merge 20 commits into
base: master
Choose a base branch
from

docs(README) Examples

a191782
Select commit
Loading
Failed to load commit list.
Draft

docs(README) Overhaul README #592

docs(README) Examples
a191782
Select commit
Loading
Failed to load commit list.
Codecov / codecov/project succeeded May 30, 2026 in 1s

55.06% (+3.77%) compared to 5a34cc5

View this Pull Request on Codecov

55.06% (+3.77%) compared to 5a34cc5

Details

Codecov Report

❌ Patch coverage is 85.45035% with 63 lines in your changes missing coverage. Please review.
✅ Project coverage is 55.06%. Comparing base (5a34cc5) to head (a191782).

Files with missing lines Patch % Lines
src/libtmux/_internal/waiter.py 85.30% 23 Missing and 23 partials ⚠️
...examples/_internal/waiter/test_wait_until_ready.py 25.00% 9 Missing ⚠️
tests/examples/_internal/waiter/helpers.py 30.00% 7 Missing ⚠️
...mples/_internal/waiter/test_mixed_pattern_types.py 90.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #592      +/-   ##
==========================================
+ Coverage   51.29%   55.06%   +3.77%     
==========================================
  Files          25       40      +15     
  Lines        3488     3921     +433     
  Branches      686      759      +73     
==========================================
+ Hits         1789     2159     +370     
- Misses       1404     1444      +40     
- Partials      295      318      +23

☔ View full report in Codecov by Sentry.
📢 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.
View more details on Codecov