Development record
itd-179 round-2 ruthless cosmetics: backticked wontfix flag usage, double-counted redaction spans, refusal message names a cause that did not occur
issueresolvednitpickiss-2608301212428844
itd-179 round-2 ruthless cosmetics: backticked wontfix flag usage, double-counted redaction spans, refusal message names a cause that did not occur
Found by the round-2 adversarial ruthless review of build/itd-179. Three nits, batched.
internal/surface/cli/cli.go:2655— backticks inside the wontfix--groundsusage string make cobra'sUnquoteUsagetake the first backquoted word as the flag's value placeholder and strip it from the prose, soabcd capture wontfix --helpprints--grounds declinedinstead of--grounds string. The same wrong string is committed in the generateddocs/reference/cli/commands.md:227.promoteandresolve, which usegroundsFlagUsage, render correctly. Remedy: drop the backticks and regenerate the reference doc.
internal/core/capture/workflow.go:362withinternal/core/capture/ grounds.go:63— a wontfix whose grounds are derived from the reason redacts the same operand twice and reports the sum, so one redactable span prints "redacted 2 span(s) before writing". Both written fields are correctly redacted; only the count over-reports, and it changed from 1 to 2 for callers reading it.
internal/core/capture/grounds.go:68-69— the refusal for a whitespace-only wontfix reason says "the reason is empty after redaction", naming a cause that did not occur; it previously said "wontfix_reason must be a non-empty string". A refusal that misnames its cause sends the operator to the wrong remedy.
Grounds
- pursued: we expect a refusal that misnames its cause and a count that over-reports to cost more operator time than the three lines they take to fix, and a help page printing --grounds declined is the visible end of it
Frontmatter
| id | iss-2608301212428844 |
|---|---|
| type | issue |
| lifecycle | resolved |
| severity | nitpick |
.abcd/work/issues/resolved/iss-2608301212428844-itd-179-round-2-ruthless-cosmetics.md
open on GitHub ↗ · commit history ↗
mentions2
- iss-2610251559033353abcd capture --help and docs/reference/cli/commands.md:492 render the remedy flag as --remedy abcd capture remedy the proposed fix, one line (required); abcd capture remedy rewrites it later. The usage string at internal/surface/cli/cli.go:5322 backquotes abcd capture remedy. pflag's UnquoteUsage takes the first backquoted span as the flag's value placeholder, so the placeholder reads as a command instead of string. This is the class iss-2608301212428844 resolved for --grounds. TestGroundsFlagUsageRendersAStringPlaceholder (internal/surface/cli/capture_surface_test.go:1220) pins only the three --grounds flags, so --remedy slipped through. It is the only such placeholder on the page.
- itd-179The reasoning behind what was pursued no longer evaporates at the gate — readiness and triage record grounds for the conjecture, not only the decision