Suggestion: add one CLI usage example up-front #141
Merged
Conversation
This file contains 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
`--help` is great but it's also good to show one valid example usage, especially for such a useful and practical tool. I think for the one usage example, it should show how to run a command (i.e. in quotes if it contains spaces), and that paths come second.
Codecov Report
@@ Coverage Diff @@
## main #141 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 6 6
Lines 372 372
Branches 79 79
=========================================
Hits 372 372 Continue to review full report at Codecov.
|
|
thanks so much. |
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.
--helpis great but it's also good to show one valid example usage, especially for such a useful and practical tool. I think for the one usage example, it should show how to run a command (i.e. in quotes if it contains spaces), and that paths come second.