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

Added help for commands #113

Open
cldwalker opened this issue Jun 16, 2010 · 2 comments
Open

Added help for commands #113

cldwalker opened this issue Jun 16, 2010 · 2 comments

Comments

@cldwalker
Copy link
Contributor

Right now there isn't a consistent way to get help for any command. A few take '-h' and rip help only prints general help.

This branch enables help for commands using the assumption that ## means documentation as seen in a few places. Also fixes some doc inconsistencies.

While writing help tests I noticed that rip --version is using git which only works correctly when you're in the rip directory. Should I change it to print Rip::VERSION instead?

@josh
Copy link
Contributor

josh commented Jun 16, 2010

Leaving this to defunkt, but I think the most the docs should be in the manpages.

Also, wouldn't want to use the double ## convention. Tomayko has a few conventions for this already in his rtomayko@shocco and rtomayko@rocco projects.

@cldwalker
Copy link
Contributor Author

I reimplemented this as a plugin if that's more appealing. This time I didn't assume the '##' convention.

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