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

Display subcommand short desc in synopsis #114

Closed
justin-corn opened this issue Dec 10, 2021 · 1 comment
Closed

Display subcommand short desc in synopsis #114

justin-corn opened this issue Dec 10, 2021 · 1 comment

Comments

@justin-corn
Copy link

When using nested subcommands, subcommand description text is not displayed next to each subcommand in the synopsis SUBCOMMANDS section. This would be helpful for usage understanding, and a cursory reading of the source for zio-cli seems to suggest that it was originally intended behavior.

Given a subcommand hierarchy like this

foo
└── a
    └── one
        ├── blue
        └── red

the command foo a one --help produces

SYNOPSIS

    foo   <command> [<args>]

SUBCOMMANDS

      - red

      - blue

The expected output would have some brief summary of subcommands red and blue to the right of their enumeration.

@justin-corn
Copy link
Author

I think this can be closed, I probably wasn't using the lib correctly. I've been working on a fix for #113 , so it's possible that fix is doing the trick, but either way I can see subcommand descr displayed correctly in these cases; this issue therefore seems like a duplicate or non-issue.

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