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

#[arg(value_delimiter = ':')] Delimiter isnt displayed in the help message. #5392

Open
2 tasks done
max-ishere opened this issue Mar 11, 2024 · 1 comment
Open
2 tasks done
Labels
A-help Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations S-waiting-on-design Status: Waiting on user-facing design to be resolved before implementing

Comments

@max-ishere
Copy link

Please complete the following tasks

Clap Version

4.5.2

Describe your use case

Most of the arguments are already documented by clap, I didnt even have to do anything (nice). However the delimiter doesnt show up in the help message.

    /// Colon-separated list of lock types
    #[arg(required = true, value_delimiter = ':')]
    #[clap(long)]
    what: Vec<InhibitTarget>,
Options:
      --what <WHAT>  Colon-separated list of lock types [possible values: shutdown, sleep, ...]

Describe the solution you'd like

The delimiter should be shown like this:

Options:
      --what <WHAT>  [`:` separated list of: shutdown, sleep, ...]

Alternatives, if applicable

No response

Additional Context

No response

@max-ishere max-ishere added the C-enhancement Category: Raise on the bar on expectations label Mar 11, 2024
@epage epage added A-help Area: documentation, including docs.rs, readme, examples, etc... S-waiting-on-design Status: Waiting on user-facing design to be resolved before implementing labels Mar 11, 2024
@epage
Copy link
Member

epage commented Mar 11, 2024

For #4812, we are looking at including it within the example usage. I'd be interested in exploring ways of doing that here as well.

@max-ishere max-ishere changed the title `#[arg(value-delimiter = ':')] Delimiter isnt displayed in the help message. `#[arg(value_delimiter = ':')] Delimiter isnt displayed in the help message. Mar 12, 2024
@max-ishere max-ishere changed the title `#[arg(value_delimiter = ':')] Delimiter isnt displayed in the help message. #[arg(value_delimiter = ':')] Delimiter isnt displayed in the help message. Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-help Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations S-waiting-on-design Status: Waiting on user-facing design to be resolved before implementing
Projects
None yet
Development

No branches or pull requests

2 participants