Skip to content

docs: Document rationale for QueueWorkItem overloads#458

Merged
ZjzMisaka merged 1 commit intomainfrom
docs-Document-rationale-for-QueueWorkItem-overloads
Apr 14, 2026
Merged

docs: Document rationale for QueueWorkItem overloads#458
ZjzMisaka merged 1 commit intomainfrom
docs-Document-rationale-for-QueueWorkItem-overloads

Conversation

@ZjzMisaka
Copy link
Copy Markdown
Owner

Add an XML summary to PowerPool explaining the design choice to provide many QueueWorkItem overloads. The comment notes the intent to keep the API strongly typed without a source generator (trading binary size for ease of use) and cites similar brute-force overloading patterns in the .NET runtime (Tuple/Action/Function) as precedent. This is a documentation-only change in PowerThreadPool/Core/PowerThreadPool.QueueWorkItem.cs.

Add an XML summary to PowerPool explaining the design choice to provide many QueueWorkItem overloads. The comment notes the intent to keep the API strongly typed without a source generator (trading binary size for ease of use) and cites similar brute-force overloading patterns in the .NET runtime (Tuple/Action/Function) as precedent. This is a documentation-only change in PowerThreadPool/Core/PowerThreadPool.QueueWorkItem.cs.
@ZjzMisaka ZjzMisaka self-assigned this Apr 14, 2026
@ZjzMisaka ZjzMisaka added the documentation Improvements or additions to documentation label Apr 14, 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 064fda5 into main Apr 14, 2026
5 of 6 checks passed
@ZjzMisaka ZjzMisaka deleted the docs-Document-rationale-for-QueueWorkItem-overloads branch April 14, 2026 02:55
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 14, 2026

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #458   +/-   ##
=========================================
  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