Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add ros-get help #41

Open
alberth opened this issue Dec 9, 2017 · 2 comments
Open

add ros-get help #41

alberth opened this issue Dec 9, 2017 · 2 comments

Comments

@alberth
Copy link
Contributor

alberth commented Dec 9, 2017

Many sub-command programs also have a sub-commmand 'help' to get a little guidance with the commands (usually a list of known commands). It's a bit more helpful than throwing a usage error what it currently answers:

usage: ros-get [-h] [-v]
               {install,update,list,remove,ws-create,ws-switch,ws-save,ws-list,ws-locate}
               ...
ros-get: error: invalid choice: 'help' (choose from 'install', 'update', 'list', 'remove', 'ws-create', 'ws-switch', 'ws-save', 'ws-list', 'ws-locate')
@Rayman
Copy link
Owner

Rayman commented Dec 11, 2017

We already have the following:

ros-get --help
ros-get install --help

What would ros-get help do? A more elaborate explanation?

@alberth
Copy link
Contributor Author

alberth commented Dec 11, 2017

Less elaborate, imho, for inspiration try

git help
svn help
hg help

It's not that strange that people will try ros-get help imho. Ideal is that it outputs something similar to what ros-get --help does (can't try that now, so not sure what it prints exactly, but a list of available commands goes a long way). At the very least, it could print "Sorry, no help topic available, try 'ros-get --help' instead" which is better than producing an error.

These programs also have help <topic> as command for more elaborate help. git jumps to the git-<topic> man-page at my system, svn and hg have elaborate topic pages as online documentation (and less man-pages.)
I think it's a bit early to support topics of help now, unless it's easy to reroute it to ros-get <topic> --help in some way. Maybe some relevant pieces of the manual could be used here eventually?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants