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

Auto-generate command documentation #6

Open
patmaddox opened this issue Dec 8, 2014 · 5 comments
Open

Auto-generate command documentation #6

patmaddox opened this issue Dec 8, 2014 · 5 comments

Comments

@patmaddox
Copy link
Member

A few commands don't show up in the help output.

It would be cool to generate the help output from the command definitions.

Or maybe use something like Thor?

@aaronmcadam
Copy link
Contributor

Have you thought about YARD? Or would that be a bit too heavy duty? I've got some experience with it if you want, but I'd probably need to get a much better understanding of what the code is doing.

@patmaddox
Copy link
Member Author

I think YARD is awesome... although we're specifically talking about the commands that it supports.

for example, the commands defined here could produce their own documentation

of course, we could use something like Thor to do that as well... all part of the evolution!

@aaronmcadam
Copy link
Contributor

ohh, you mean you'd like a more robust command-line help system? Thor is interesting, I've never had to use it though. I've dabbled a little bit in OptionParser gem (I think that's what it's called).

@patmaddox
Copy link
Member Author

yeah OptionParser is another tool we could use

@sublimecoder
Copy link
Contributor

I think either of those two gems would get the job done and in a pretty clean fashion.

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

3 participants