Skip to content

README: fixes and FAQ answers from an outside read-through - #14

Merged
HalRiveria merged 4 commits into
mainfrom
docs/readme-review
Oct 28, 2026
Merged

HalRiveria merged 4 commits into
mainfrom
docs/readme-review

Conversation

@HalRiveria-Bot

Copy link
Copy Markdown
Collaborator

Docs only. Fixes from reading the README as a new user would.

What was wrong, and what changed:

  • Quick start pasted at the prompt. It failed there, since $PSScriptRoot is empty outside a saved script. A comment now says to use . .\ParallelKit.ps1 at the prompt.
  • Quick start's failure check. It reported aborted commands as failures; it now skips them.
  • Abort steps. The numbered steps said Ctrl+C or closing the window waits for running work, which contradicted the next paragraph. They're now for Ctrl+C, and window close is described as skipping the wait.
  • After an abort. Nothing said that the script carries on afterwards. A new note gives if ($batch.Aborted) { exit 1 } to stop it.
  • Defaults. The batch and runspace-job defaults (concurrency, drain timeouts, -TimeoutSeconds) weren't stated where the options are introduced.
  • Variables inside Invoke-PkRun. A variable named like one of Invoke-PkRun's own ($KeepAwake, say) silently reads the kit's value inside the block. The README now says so, with the .GetNewClosure() fix. Checked by running it.
  • New FAQ answers: pipeline input, which functions are public, and whether child programs get Ctrl+C.
  • "Bugs and questions" section pointing to GitHub issues.

Testing. Docs only, so no harness change. It merges cleanly with #11, #12 and #13.

🤖 Generated with Claude Code

HalRiveria and others added 4 commits October 28, 2026 04:09
- Quick start: say it's for a saved script ($PSScriptRoot is empty at
  the prompt), and skip aborted commands instead of reporting them as
  failures.
- Abort: the numbered steps are for Ctrl+C; a window close skips the
  wait. New note that the script carries on after an abort, with the
  `exit` line to stop it.
- State the defaults for the batch and runspace-job time limits and
  concurrency.
- Invoke-PkRun: a variable named like one of its own reads its value
  inside the block unless the block uses .GetNewClosure().
- FAQ: pipeline input, which functions are public, and whether child
  programs get Ctrl+C.
- A "Bugs and questions" section pointing to GitHub issues.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
On a window close the drain is skipped (Windows ends the process within
seconds), but the announcement still said 'finishing current jobs,
please wait'. It now says jobs are being stopped, matching the README.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@HalRiveria
HalRiveria merged commit 8c8bc27 into main Oct 28, 2026
2 checks passed
@HalRiveria
HalRiveria deleted the docs/readme-review branch October 28, 2026 09:11
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