Repository navigation
docs(#22): document --no-config and --dump-index in --help and README CLI block - #24
Merged
Merged
Conversation
… CLI block docs/plan.md requires the help text, the README CLI block, and the plan to agree on flags; --no-config was documented in neither user-facing place and --dump-index was missing from the README. The help contract test now locks both flags in.
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.
Closes #22
What & why
docs/plan.mdrequires--help, the README CLI block, and the plan to agree on flags. Two real, supported flags were missing on the user-facing sides:--no-config— documented nowhere user-facing; now in--help(newConfig:section) and the README CLI block, wording consistent withdocs/configuration.md.--dump-index— was in--helponly; now also in the README CLI block.TDD: extended
testHelpDocumentsTheCliContractfirst (watched it fail on the missing--no-config), then added the help line. Both flags are now locked into the contract test.Checklist
composer checkis green (cs + stan + md + test — 526 tests, 1739 assertions)composer infection:diffis green (covered-code MSI 94%, gate is 80)develop(nevermain)