Skip to content

README: splatting in examples, quick start for the common case - #2

Merged
HalRiveria merged 1 commit into
mainfrom
docs/readme-splatting-quickstart
Oct 27, 2026
Merged

HalRiveria merged 1 commit into
mainfrom
docs/readme-splatting-quickstart

Conversation

@HalRiveria-Bot

Copy link
Copy Markdown
Collaborator

What was wrong

  • The longer examples wrapped calls with trailing backticks, which are easy to break (a space after the backtick) and harder to read.
  • The README made the kit look more complicated than the common case is: the worker rules, closures and callback contract read as if they applied to everyone.

What changed

  • Examples for Invoke-PkProcessBatch, Invoke-PkRunspaceJobs and Invoke-PkProcessDispatch now use splatting.
  • New Quick start section near the top: the one-call Invoke-PkProcessBatch case, with a note that the worker rules and callback details don't apply to it.
  • "The three rules for worker code" now opens by saying it only concerns Invoke-PkRunspaceJobs (or a dispatcher called from one of its workers).
  • Arguments examples build quoted paths with -f instead of escaped quotes.
  • Test badge links point at the renamed repo.

How it was tested
Ran each new example against ParallelKit.ps1 under Set-StrictMode -Version Latest, with cmd.exe standing in for cjxl.exe: the quick start reports a failing and an unstartable command, the splatted batch/runspace/dispatch examples all complete, and CheckWorkerSafety = $true in a splat still refuses an unsafe worker. No code changes, so the Harness check covers the rest.

🤖 Generated with Claude Code

Co-authored-by: Claude Opus 5.5 noreply@anthropic.com

- Long examples use splatting instead of trailing-backtick continuations.
- New Quick start section: the one-call Invoke-PkProcessBatch case, and a
  note that the worker rules and callback details don't apply to it.
- The three worker rules now say up front that they only concern
  Invoke-PkRunspaceJobs.
- Arguments examples quote paths with -f instead of escaped quotes.
- Badge links point at the renamed repo.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@HalRiveria
HalRiveria merged commit e8add3e into main Oct 27, 2026
1 check passed
@HalRiveria
HalRiveria deleted the docs/readme-splatting-quickstart branch October 27, 2026 20:52
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