docs: document how invalid input is rejected, and fix drifted signatures#881
Merged
Conversation
Seven releases hardened the CLI to reject unknown options, out-of-range values and unusable bootstrap/report paths, and none of it was written down. Adds a Command line section covering all three, with output verified against the real messages. Also corrects drift found while auditing: - snapshots.md omitted the optional ["snapshot_file"] argument that both snapshot assertions accept - README claimed 'hundreds of assertions' one line above '~70'; it is 71 - BASHUNIT_REPORT_TAP and BASHUNIT_REPORT_JSON were undocumented while their JUnit/HTML/GHA siblings were - standalone.md did not state that a malformed invocation exits 1 - test-doubles.md was missing backticks on one signature - benchmarks.md did not mention @max_ms accepts decimals
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
1 participant
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.
🤔 Background
#871–#880 hardened the CLI to reject unknown options, out-of-range values and unusable
bootstrap/report paths. None of that behaviour was documented anywhere — a user hitting
Error: unknown option '--parralel'had no page explaining it.Auditing the rest of the markdown surface turned up several drifted signatures alongside it.
💡 Changes
BASHUNIT_REPORT_TAPandBASHUNIT_REPORT_JSONin Configuration, next to the JUnit/HTML/GHA reports they belong with, and confirm both work as environment variablessnapshots.mdomitted the optional["snapshot_file"]both snapshot assertions accept,standalone.mddid not state that a malformed invocation exits1,benchmarks.mddid not mention@max_msaccepts decimals, and onetest-doubles.mdsignature was missing backticks