docs(project-overview): benchmarks are a subcommand, not a flag - #1228
Merged
Conversation
The Running tests block told new contributors to use `-s -b` and `--simple --bench`. Neither exists -- both are rejected as unknown options, and `git log -S` finds no sign either was ever a flag. Benchmarks are `bashunit bench [path]`, which --help advertises. The regular-test commands two lines above are correct, which is what made the broken pair easy to miss. Closes #1227
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
Related #1227
The project overview — the page that orients new contributors — told them to run benchmarks with
./bashunit -s -b testsand./bashunit --simple --bench tests. Both are rejected as unknown options, andgit log -Sfinds no sign either was ever a flag. Benchmarks are thebashunit bench [path]subcommand.The regular-test commands two lines above are correct, which is what made the broken pair easy to miss.
💡 Changes
tests/path