expand usage section of README #116
Merged
Conversation
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
Signed-off-by: Matthew Peveler <matt.peveler@gmail.com>
zlatanvasovic
approved these changes
May 16, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Expands the usage section of the README to show the same message as typing
tldr --help.The custom string for the
usageargument of argparse is unfortunate, but it's the only way to get the positional arguments section to show up, while also not showingcommandas totally optional. This is also probably simpler than writing up a custom formatter for argparse.I could see writing a note below this section to explain the handling of command (e.g. you can type multiple words and will be automatically concatenated (e.g.
git rm->git-rm) or something.