search

uber-node / tcurl

A command line utility to talk to tchannel servers
MIT License
36 stars 7 forks source link

Support for helpUrl and improved help text and usage.md #72

Open andrewdeandrade opened 9 years ago

andrewdeandrade commented 9 years ago

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.

andrewdeandrade commented 9 years ago

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?

@kriskowal @Raynos @ShanniLi

kriskowal commented 9 years ago

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.

andrewdeandrade commented 9 years ago

Is this in a good place to rebase and land? @kriskowal @ShanniLi

kriskowal commented 8 years ago

Consider breaking into a PR for the help URL feature and a separate PR for the help audit.