docs: say that --issues picks a destination, not a run mode, in simplify and config - #140
Merged
Conversation
…nd scope it to the pipeline commands
Closed
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Open PR #136 already covers most of #135 — it rewrote the
--issuesbullet and the--scan-onlygate inbetter.md,better-swift.md,depfree.md,lib/plan-issue-mode.md, andlib/review-config-defaults.md. This is the disjoint remainder: the two places that still describe--issuesas if it were a run mode, on files #136 does not touch (no overlap, no conflict).commands/do/simplify.md— the pass-through flag list lumped--issues/--issues-labelin with the flags that stop the run (--scan-only,--no-merge), which is precisely the misreading --issues reads as a run mode but is a sink selector; --scan-only --issues is underspecified #135 was filed about; the issue's Context section names a/do:simplify --issuesrun as where it surfaced.--issuesnow gets its own bullet stating that it selects where deferred findings are recorded, that the run still remediates / PRs / merges, and that--scan-only --issuesfiles every surviving finding as the run's entire output.commands/do/config.md— both places describing the savedissuesdefault (the prose paragraph and the key reference) now note that issue mode changes only where findings are recorded, never whether the run remediates. This is the config key --issues reads as a run mode but is a sink selector; --scan-only --issues is underspecified #135 identifies as load-bearing: someone with{"defaults": {"issues": true}}needs to know it does not silently disable fixes.review.mdandrpr.mdare deliberately untouched — both already scope their--issuesbullet to deferred findings, the same reasoning #136 gave for leavingreview.mdalone. The--triagealias floated in #135 is also out, matching #136's decision that one discoverable spelling (--scan-only --issues) beats two.Refs, notCloses, since #136 carries theCloses #135trailer and lands the larger half.Remaining
Nothing beyond what #136 already ships. Once both merge, #135's acceptance criteria are covered except the optional
--triagealias, which both PRs explicitly declined.Test plan
Docs-only; no executable behaviour changes.
npm test— 187/187 passgit diff --statconfirms onlysimplify.md,config.md, and the changelog entry changedbetter.md,better-swift.md,depfree.md,lib/plan-issue-mode.md,lib/review-config-defaults.md)Refs #135