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.

Sign up for GitHub

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

Jump to bottom

flag level help can show exclusive/dependsOn #1002

Open
mshanemc opened this issue Feb 4, 2021 · 1 comment
Open

flag level help can show exclusive/dependsOn #1002

mshanemc opened this issue Feb 4, 2021 · 1 comment
Labels
--help output Related to --help output good first issue Good for newcomers help wanted Accepting PRs

Comments

@mshanemc
Copy link
Member

mshanemc commented Feb 4, 2021

some flag properties (required, default, options) show up at the flag-level help.

It would be cool if dependsOn and exclusive did, too.

Right now, we rely descriptions (or errors) to tell the user what they should have done.
@mshanemc
Copy link
Member Author

mshanemc commented Feb 4, 2021 •
edited
Loading

I'd use brackets on them similar to how default works?

dependsOn

myFlag         [needs otherFlag,anotherFlag] actual flag help

exclusive

myFlag         [don't use with otherFlag,anotherFlag] actual flag help

@mdonnalley mdonnalley transferred this issue from oclif/plugin-help Mar 5, 2024
@mdonnalley mdonnalley added good first issue Good for newcomers help wanted Accepting PRs --help output Related to --help output labels Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
--help output Related to --help output good first issue Good for newcomers help wanted Accepting PRs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mshanemc @mdonnalley