-
-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Make visible_alias print in a way that fits convention #5459
Comments
Could you go into more detail on this as this is meant to be the jumping off point in the conversation. For example
I assume you are somewhat connected with @tertsdiepraam who opened #5454. In that, concerns raised on the proposed output include
|
Nope, I don't know @lolbinarycat. But we could use this issue as it seems to he about the same thing. Thanks for the mention and I'll follow this issue. |
essentially every program that has aliases either prints them together, or prints them entirely separately, with the alias having a description like "alias for --some-other-flag" for an example of the former see gnu tar (literally the first command i tried when you asked for an example) |
I had tried three or so commands and couldn't find examples of aliases. Its also good to get from a variety of design spaces to explore multiple options. If you could find more prior art, that would be helpful. Relevant parts from Sometimes they use next line help
Sometimes they affect alignment
When they take a value, they don't list the value for the short but they do for each long
|
I would love for this to be implemented, such that it is easier to see from the --help dialouge.
In terms of ordering I think:
Would make the most sense. |
Please complete the following tasks
Clap Version
4.5.4
Describe your use case
print aliases in an easily understood way
Describe the solution you'd like
currently, aliases are printed at the end of the flag's description. i believe it would be much more natural to print them as
-f, --flag, --alias description
Alternatives, if applicable
No response
Additional Context
No response
The text was updated successfully, but these errors were encountered: