This repository has been archived by the owner on Sep 25, 2020. It is now read-only.
Support for helpUrl and improved help text and usage.md #72
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
|
Q: should I remove the exit codes from the README.md document since they are also documented in the usage.md file? Q: Should the localhost caveat be moved to the usage.md file? |
| [-2 | --arg2 | --head] [-3 | --arg3 | --body] | ||
| [--shardKey] [--no-strict] [--timeout] | ||
| [--http] [--raw] [--health] | ||
| `tcurl` <service> <endpoint> <options> |
There was a problem hiding this comment.
`tcurl [OPTIONS] service endpoint`
The options are usually not enumerated in the synopsis of a man page, and typically are for usage on the command line.
|
A: yes, let’s DRY up the exit codes, making the usage.md the authority. Let’s add a link to README.md to usage.md to make it discoverable for casual visitors to the repository. A: yes, let’s move the caveat to the man page. |
|
Is this in a good place to rebase and land? @kriskowal @ShanniLi |
| -3 --body <value> Set body to <value> | ||
| --http <method> Use HTTP <method> instead of TCP | ||
| --health Print health for <service> | ||
| --raw Send header and body as binary diaray |
|
Consider breaking into a PR for the help URL feature and a separate PR for the help audit. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The previous help text was more useful and the current help text did not make it obvious that you would get more detailed help information if you executed
tcurl --help. I reverted to a style like the previous help text but better formatted. I also added support for a helpUrl option to be printed in the short help.