You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
lread
changed the title
[Ftr] Consider positional arguments help
[Ftr] Separate positional arguments help from options help
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:
Describe the solution you'd like
I think separating out the positional args from the options would be clearer:
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.The text was updated successfully, but these errors were encountered: