docs: purge every literal "--max-iterations 0" mention from docs and tests#17
Merged
Merged
Conversation
…tests Follow-up to #16. The previous PR removed the canonical "--max-iterations 0" example but left explanatory sentences like "you no longer need to pass --max-iterations 0" in the docs and a backward-compat test name in test/setup.test.js. Those still printed the literal "--max-iterations 0" to readers, defeating the point of the cleanup. This PR removes every remaining occurrence. ## Why Telling users "you don't need to write --max-iterations 0 anymore" still shows them "--max-iterations 0". A new user reading the docs has no prior knowledge of the legacy form, so explaining what NOT to write just plants the wrong syntax in their head. Cleaner: omit the deprecation note entirely. New users see only the "omit the flag for unlimited" guidance. Existing users who happen to pass 0 keep working silently. ## What changed - **`commands/help.md`**: - `--max-iterations` Options description: dropped the trailing "You no longer need to pass --max-iterations 0..." sentence - Best Practices #4: dropped the trailing "you do not need to pass --max-iterations 0" sentence - **`scripts/setup-watchdog.js` printHelp()**: dropped the "You do NOT need to pass --max-iterations 0 anymore." line from the help-output trailer - **All 7 READMEs** (`README.{md,zh,es,ja,ko,vi,pt}.md`): - --no-classifier subsection paragraph: dropped the "you no longer need to pass --max-iterations 0" trailing sentence - Best Practices #4 paragraph: dropped the same trailing sentence - **`test/setup.test.js`**: - Renamed test from "setup --no-classifier + --max-iterations 0 is allowed (infinite loop, manual stop only)" to "setup --no-classifier with no max cap is allowed (infinite loop, manual stop only)" - Test args changed from `['build', '--no-classifier', '--max-iterations', '0']` to `['build', '--no-classifier']` - Added a comment explaining that the recommended way to express "unlimited" is omission, and that the state file's max_iterations=0 default is what makes the stop hook treat the loop as uncapped ## Backward compatibility **Identical** to the previous state. The parser still accepts --max-iterations 0; the stop hook still treats max_iterations=0 as "no cap" (the > 0 guard fails). Anyone who was passing 0 explicitly keeps working. The only change is that the literal string "--max-iterations 0" no longer appears anywhere in the docs, the in-Claude-Code help, or test names that get printed in CI logs. Confirmed via `Grep "--max-iterations 0"` returning **zero matches** across the entire repo. ## Test plan - [x] 132-test suite still passes (132 active + 2 skipped, 0 failures) - [x] node --test test/*.test.js clean - [x] Grep "--max-iterations 0" returns zero matches in the repo - [ ] CI will confirm on the standard matrix Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.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
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.
Follow-up to #16. The previous PR removed the canonical `--max-iterations 0` example but left explanatory sentences like "you no longer need to pass `--max-iterations 0`" in the docs and a backward-compat test name in `test/setup.test.js`. Those still printed the literal `--max-iterations 0` to readers, defeating the point of the cleanup. This PR removes every remaining occurrence.
Why
Telling users "you don't need to write `--max-iterations 0` anymore" still shows them `--max-iterations 0`. A new user reading the docs has no prior knowledge of the legacy form, so explaining what NOT to write just plants the wrong syntax in their head. Cleaner: omit the deprecation note entirely. New users see only the "omit the flag for unlimited" guidance. Existing users who happen to pass `0` keep working silently.
What changed
commands/help.md--max-iterationsOptions description: dropped the trailing "You no longer need to pass `--max-iterations 0`..." sentencescripts/setup-watchdog.jsprintHelp()All 7 READMEs (
README.{md,zh,es,ja,ko,vi,pt}.md)--no-classifiersubsection paragraph: dropped the "you no longer need to pass `--max-iterations 0`" trailing sentencetest/setup.test.jsBackward compatibility
Identical to the previous state. The parser still accepts `--max-iterations 0`; the stop hook still treats `max_iterations=0` as "no cap" (the `> 0` guard fails). Anyone who was passing `0` explicitly keeps working. The only change is that the literal string `--max-iterations 0` no longer appears anywhere in the docs, the in-Claude-Code help, or test names that get printed in CI logs.
Confirmed via `Grep "--max-iterations 0"` returning zero matches across the entire repo.
Test plan
Scope
Zero changes to `lib/`, `hooks/`, `.claude-plugin/`, or any other production code. No version bump.
Co-Authored-By: Claude Opus 4.6 (1M context) noreply@anthropic.com