Skip to content

docs: Revise 'Why PTP' section in README#461

Merged
ZjzMisaka merged 1 commit intomainfrom
docs-Revise-'Why-PTP'-section-in-README
May 6, 2026
Merged

docs: Revise 'Why PTP' section in README#461
ZjzMisaka merged 1 commit intomainfrom
docs-Revise-'Why-PTP'-section-in-README

Conversation

@ZjzMisaka
Copy link
Copy Markdown
Owner

Rewrite and clarify the "Why PTP" section: simplified and rephrased bullet points, made Pool/Worker/Work lifecycle and state management explicit, added a link to the sync/async design note, and noted optimizations (CAS, work-stealing, debounce). Also added guidance on suitable scenarios and caveats (when not to use PTP) to help users decide whether the library fits their needs.

Rewrite and clarify the "Why PTP" section: simplified and rephrased bullet points, made Pool/Worker/Work lifecycle and state management explicit, added a link to the sync/async design note, and noted optimizations (CAS, work-stealing, debounce). Also added guidance on suitable scenarios and caveats (when not to use PTP) to help users decide whether the library fits their needs.
@ZjzMisaka ZjzMisaka self-assigned this May 6, 2026
@ZjzMisaka ZjzMisaka added the documentation Improvements or additions to documentation label May 6, 2026
Copy link
Copy Markdown
Owner Author

@ZjzMisaka ZjzMisaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

self checked

@ZjzMisaka ZjzMisaka merged commit b21a933 into main May 6, 2026
5 of 6 checks passed
@ZjzMisaka ZjzMisaka deleted the docs-Revise-'Why-PTP'-section-in-README branch May 6, 2026 02:49
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (07c0ea6) to head (904d832).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #461   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           65        65           
  Lines         5572      5572           
  Branches       654       654           
=========================================
  Hits          5572      5572           

☔ 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.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant