From 92c1d49ade398b20d0e5dcce4deaf4fd98f3a000 Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Mon, 12 Oct 2026 17:42:32 +0000 Subject: [PATCH] Clarify requirements flag repetition --- docs/cli.md | 6 +++--- docs/roadmap/remediation.md | 10 ++++++++-- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index cea90b5..84e9d3b 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -415,9 +415,9 @@ omission. PromptKit owns their interpretation, including default version and profile selection, session context, and selection errors. Requirements inspection does not require a profile to be execution-ready. See the pinned [PromptKit requirements API](https://gitea.maximumdirect.net/eric/promptkit/src/commit/143c6e9b3a675872117b0471e2ff8bcb25055a54/requirements.go) -for the owning discovery contract. The built-in flags are singleton bindings; -when repeated, the last value is used. Suite selectors retain their declared -binding behavior. +for the owning discovery contract. The built-in flags other than `--var` are +singleton bindings; when repeated, the last value is used. Suite selectors retain +their declared binding behavior. Each `--var` occurrence must contain `=`. CommandKit splits at the first separator and preserves the exact key and remaining value. Empty keys and diff --git a/docs/roadmap/remediation.md b/docs/roadmap/remediation.md index be52356..0b08dbe 100644 --- a/docs/roadmap/remediation.md +++ b/docs/roadmap/remediation.md @@ -1,6 +1,6 @@ # PromptKit requirements inspection review -Status: three open findings. This document records required follow-up work; +Status: R-1 completed; R-2 and R-3 open. This document records follow-up work; the review does not change implementation or current contracts. ## Review scope and authority @@ -26,7 +26,7 @@ presentation beyond the selected contract. ## R-1: Correct singleton wording for requirements flags -Status: open. Priority: normal. Category: documentation contract. +Status: completed. Priority: normal. Category: documentation contract. **Evidence:** [CLI reference](../cli.md), lines 418–420, says that the built-in flags are singleton bindings and that the last value is used when repeated. @@ -49,6 +49,12 @@ change is required. its flag table and prose. Check the wording against the existing assignment and singleton coverage; new generic parser tests are unnecessary. +**Completed:** Qualified the CLI singleton statement to exclude `--var`, retaining +the existing per-key replacement and selector-binding descriptions. Reviewed the +wording against `newRequirementsCommand` and the existing request/assignment +coverage. Local links/fragments and `git diff --check` passed. No parser, handler, +or test changes were needed. + ## R-2: Complete the canonical requirements YAML schema Status: open. Priority: normal. Category: incomplete documentation delivery.