Skip to content

README: Why Not Use X? section, FAQ, accuracy fixes - #4

Merged
HalRiveria merged 1 commit into
mainfrom
docs/readme-alternatives-faq
Oct 27, 2026
Merged

HalRiveria merged 1 commit into
mainfrom
docs/readme-alternatives-faq

Conversation

@HalRiveria-Bot

Copy link
Copy Markdown
Collaborator

What changed

  • New "Why Not Use X?" section after "Who it's for": PowerShell 7's ForEach-Object -Parallel, Start-Job, ThreadJob, PoshRSJob, a hand-built runspace pool, workflows, Start-Process/System.Diagnostics.Process, and Invoke-Command -AsJob, plus what none of them handle.
  • New FAQ before License: the cmdlet rule, other runspace tools, PowerShell 7 / Linux / macOS, admin rights, dot-sourcing vs a module, Ctrl+C and force-kill behaviour, progress, limits, and AI use.
  • Accuracy fixes from a review against the code and Microsoft's docs:
    • A window close skips the drain wait (top bullet and comparison list).
    • 5.1 ships with Windows 10 1607+, Windows 11 and Server 2016+, not every Windows 10/Server.
    • Only the abort handler and child-process cleanup warn on failure.
    • Invoke-PkProcessWithTimeout under Invoke-PkRun kills the program and throws on abort.
    • Only -ResultHandler, -PollCallback and -NextJobProvider stop a run when they throw.
    • Held groups don't block the dispatcher's return on cancel/abort.
    • A -Cts is cancelled by an abort; a dispatcher -CancelToken isn't, but the dispatcher stops either way.
    • QuickEdit freeze wording narrowed to the classic console window.
    • Remoting to localhost needs an elevated session.

Tested: every function, parameter, default, return shape and anchor checked against ParallelKit.ps1; the examples were run in a fresh powershell -NoProfile. Docs-only, no code changes.

🤖 Generated with Claude Code

Adds a section comparing ParallelKit with Start-Job, ThreadJob, PoshRSJob,
ForEach-Object -Parallel and other options, and an FAQ covering the worker
rules, platform support, abort behaviour and progress. Also corrects claims
found in an accuracy review: window close skips the drain wait, which Windows
versions ship 5.1, which callbacks stop a run when they throw, the
-Cts/-CancelToken difference, held groups on cancel, QuickEdit, and remoting.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@HalRiveria
HalRiveria merged commit 94360c1 into main Oct 27, 2026
1 check passed
@HalRiveria
HalRiveria deleted the docs/readme-alternatives-faq branch October 27, 2026 23:00
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.

2 participants