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

Feature request: more automatic documentation for flags in --help #39

Open
olafurpg opened this issue Aug 25, 2016 · 2 comments
Open

Feature request: more automatic documentation for flags in --help #39

olafurpg opened this issue Aug 25, 2016 · 2 comments
Milestone

Comments

@olafurpg
Copy link
Contributor

olafurpg commented Aug 25, 2016

Just some fancy features that I think would be cool to have. It would be nice if the --help message could

  • show the default values for options with default values.
  • mark non-optional values as required.
  • show <type> of the flag instead of "<value>". For example, <bool> for Boolean or <int*> for List[Int].
@alexarchambault
Copy link
Owner

👍 for the first two points at least.

What do you mean about the flags? That the short version should be printed before the long one?

@alexarchambault alexarchambault added this to the 1.2.0 milestone Aug 30, 2016
@olafurpg
Copy link
Contributor Author

Whoops, the angle brackets in the third bullet got rendered as html tags, see updated comment.

👍 for the first two points at least.

Awesome!

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

2 participants