docs: correct CLI and integration sweep claims#1428
Merged
Conversation
A documentation audit, verified against the live binary and the pinned corpus manifest, surfaced five accuracy gaps: - `-no-color` is not implied for a non-TTY: the binary has no isatty detection and emits ANSI even when piped. Drop the false auto-disable claim; colour is on by default and `-no-color` turns it off. - A parse error emits a well-formed report (JSON an empty array, SARIF a valid run with an empty `results` list), not nothing. Correct the FAQ. - Document exit code 2 for a command-line parsing error (an unknown flag or a flag missing its value); an invalid flag value stays exit 1. - INTEGRATIONS.md and README claimed every listed integration runs the per-release sweep, but the heaviest Featured trees (oh-my-zsh, powerlevel10k, zsh-syntax-highlighting) are swept manually, not in the pinned gate. Qualify the claim to the pinned corpus matrix. Signed-off-by: afadesigns <afadesign.official@gmail.com>
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
2 participants
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.
A documentation + integration audit, every claim verified against the live binary and the pinned corpus manifest, surfaced five accuracy gaps:
-no-colorauto-TTY claim (USER_GUIDE) — the doc said it is implied when stdout is not a TTY, but the binary has no isatty detection and emits ANSI even when piped (zshellcheck file | catshows^[[33m). Dropped the false claim.resultslist) and exits 1. Corrected.oh-my-zsh,powerlevel10k,zsh-syntax-highlighting) are absent from.github/parser-corpus-manifest.txtand swept manually (their owncompat-nightly.ymlnotes the clones are too heavy to pin). Qualified to the pinned corpus matrix.Docs-only; no code or behaviour change. KATAS.md/version parity, internal links, action-pin comments, and docs-style were all audited clean.
Receipts: piped output
^[[33mwarning^[[0m(no isatty code in tree);-format sarif <broken>emits a 349-byte SARIF, exit 1;--bogusexit 2,-severity bogusexit 1; the 3 heavy corpora return 0 matches in the manifest.