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

Usage needs to show argument placeholders #597

Closed
lukehutch opened this issue Mar 3, 2025 · 2 comments
Closed

Usage needs to show argument placeholders #597

lukehutch opened this issue Mar 3, 2025 · 2 comments
Assignees

Comments

@lukehutch
Copy link
Contributor

lukehutch commented Mar 3, 2025

Currently there is no distinction in the usage list between boolean type parameters (which are just either present or absent, and don't take an argument), and parameters that require an argument (e.g. parameters that have type String).

What I would expect is something along the lines of not

  Options:
    -h, --help, -?
      Print this help message and exit
    -i, --input
      The input file

but rather

  Options:
    -h, --help, -?
      Print this help message and exit
    -i, --input <input_file>
      The input file

In other words I would like to be able to provide an extra argument placeholder="<input_file>" to the @Parameter annotation that is displayed in the above way.

I know there are custom usage formatters, but the placeholder would still need to be given in the annotation, so this really should be supported out of the box.

@mkarg
Copy link
Collaborator

mkarg commented Mar 4, 2025

As long as it contains a test proving that existing applications will not fail but new applications will show this placeholder, I would be delightet to review your PR. 👍

@lukehutch
Copy link
Contributor Author

I submitted a PR. I did not include updates to the documentation to the PR (that would need to be done too).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants