bin/verify-documented-usage.sh
is not environment agnostic
#852
Labels
bin/verify-documented-usage.sh
is not environment agnostic
#852
Describe the bug
The
bin/verify-documented-usage.sh
script checks that the usage documentation in theREADME
matches the various Topiary CLI subcommand--help
outputs. However, it does not account for line wrapping in the--help
outputs, which appear to be environment-dependent. (My suspicion is the TTY of the process, if there is one.)This leads to false negatives.
To Reproduce
In the
nix develop
dev-shell, runverify-documented-usage
. It will probably complain that theREADME
is out-of-sync with at least one of the subcommands'--help
output. (If not, resize your terminal until it does!)Expected behaviour
The output produced by the script should be wrapped at a set width (80 columns, say), so it's deterministic.
Environment
The text was updated successfully, but these errors were encountered: