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

[Ftr] Separate positional arguments help from options help #92

Open
lread opened this issue Nov 28, 2019 · 1 comment
Open

[Ftr] Separate positional arguments help from options help #92

lread opened this issue Nov 28, 2019 · 1 comment

Comments

@lread
Copy link
Contributor

lread commented Nov 28, 2019

Is your feature request related to a problem? Please describe.
While looking at #90, I noticed that the help for positional arguments is included under the OPTIONS section, for example:

NAME:
 toycalc add - Adds two numbers together

 Looks great, doesn't it?

USAGE:
 toycalc [add|a] [command options] a1 a2

OPTIONS:
       --a1 N  0  First addendum [$AA]
       --a2 N  0  Second addendum
   -?, --help

Describe the solution you'd like
I think separating out the positional args from the options would be clearer:

NAME:
 toycalc add - Adds two numbers together

 Looks great, doesn't it?

USAGE:
 toycalc [add|a] [command options] a1 a2

WHERE:
   a1 N  0  First addendum [$AA]
   a2 N  0  Second addendum

OPTIONS:
   -?, --help

Describe alternatives you've considered
None at this time.

Additional context
I do realize that the positional args would still be accessible via their equivalent options (eg --a1 and --a2) but if I have configured cli-matic for positional args, I would think the option equivalents could remain undocumented in the usage help.

@lread lread changed the title [Ftr] Consider positional arguments help [Ftr] Separate positional arguments help from options help Nov 28, 2019
@lread
Copy link
Contributor Author

lread commented Nov 29, 2019

If this makes sense to folks, I can work on a PR.

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

1 participant