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
The help message offset is inconsistent #1013
Comments
The alignment is per section (i.e. I'm going to close this as just by design. But I'm open to discussing the issue if there is an argument to be made. |
Since it's subjective, what about making it configurable? |
@marmistrz apologies I didn't get the ping that a comment was made! In general I'm ok with making things configurable, and I'm not against adding a setting does exactly this. I'll re-open the issue but can't promise when it'll be done due to my work schedule lately. I'd be happy to help someone figure this out if they'd like to work on a fairly easy to implement issue. |
That's in preparation of clap-rs#1013: provide option to layout the output of "my_program --help" with the same alignment across sections.
That's in preparation of clap-rs#1013: provide option to layout the output of "my_program --help" with the same alignment across sections.
That's in preparation of clap-rs#1013: provide option to layout the output of "my_program --help" with the same alignment across sections.
That's in preparation of clap-rs#1013: provide option to layout the output of "my_program --help" with the same alignment across sections.
That's in preparation of clap-rs#1013: provide option to layout the output of "my_program --help" with the same alignment across sections.
@epage What do you think of this? |
My general stance is to push back against configuration and prefer making a decision one way or the other :), depending on how hard the workarounds are, the number of people affected, etc. For those unaware, my motivations for low configuration are:
We might be able to re-frame this to have it and keep low configuration, like with #2913 or #2914. We could keep the mainline As for timelines, I wouldn't think this is a priority for 3.1. Putting it in my buckets (Focus Area, Planned, Someday), the prior conversation makes this seem like a Planned but my suggestion above makes this sound like a Someday or that it is Planned but blocked on #2913 and would then be targeted as a change to the lower level help generator only. |
I guess that's where we differ. I envision clap (and clap had always been) to allow all kinds of configuration so that users can choose their own preferences. Our job as maintainers is to grow the codebase to make sure those configuration options are not workarounds but rather modular and the number of people affected are less because they can opt-out. In fact, I would wager that the reason clap is so popular is because of it's flexibility. |
Rust Version
1.19.0
Affected Version of clap
2.25.1
Issue description
Take this Rust project: marmistrz/randmockery@3fa575f
(I specify the commit because the app may be developed further). When launching
randmockery --help
I getI'd expect all the help messages to be aligned to each other:
The text was updated successfully, but these errors were encountered: