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

tooling: --help option for crystal docs #5087

Closed
scriptnull opened this issue Oct 7, 2017 · 2 comments
Closed

tooling: --help option for crystal docs #5087

scriptnull opened this issue Oct 7, 2017 · 2 comments

Comments

@scriptnull
Copy link

I am very new to crystal and have been playing around with the tools.

Almost all the crystal commands have a --help option to help the user to understand its purpose better. But the crystal docs command does not seem to have one.

image

I think it would be better to have some help for it like below.

$ crystal docs
Usage: crystal docs [Options] [file]

Options:
    -h, --help      Show this message

In this way, it would be easy for adding new options and documenting them in future. (Right now crystal docs has no options, I suppose)

@straight-shoota
Copy link
Member

#4937 includes a --help option.
But we should keep this issue open until it gets merged.

@asterite
Copy link
Member

#4937 got merged so this is fixed now

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

No branches or pull requests

3 participants