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

Imperative mood for default messages #791

Closed
gitfineon opened this issue Aug 22, 2019 · 6 comments
Closed

Imperative mood for default messages #791

gitfineon opened this issue Aug 22, 2019 · 6 comments
Labels
theme: usagehelp An issue or change related to the usage help message type: doc 📘 type: enhancement ✨
Milestone

Comments

@gitfineon
Copy link
Contributor

For many tools the title and description of commands and options are in imperative mood.
How about changing the default messages like "Displays Display help information about ..."

@remkop
Copy link
Owner

remkop commented Aug 23, 2019

Thanks for looking into this. I believe picocli already uses imperative language; the standard help options look like this:

Usage: some-command
  -h, --help               Show this help message and exit.
  -V, --version            Print version information and exit.

The above two options are added when you define a command with mixinStandardHelpOptions:

@Command(mixinStandardHelpOptions = true) class SomeCommand {}

Am I missing something?

@gitfineon
Copy link
Contributor Author

You are right, didn't found any other then #796.
This showed up on including the HelpCommand.class as subcommand.

@remkop
Copy link
Owner

remkop commented Aug 26, 2019

PR merged. Thank you for the contribution!

remkop added a commit that referenced this issue Aug 26, 2019
remkop added a commit that referenced this issue Aug 26, 2019
@remkop
Copy link
Owner

remkop commented Aug 26, 2019

I reverted this commit for now:
it broke some of the tests that assert the previous HelpCommand header.
This is to be expected, but I want to avoid making breaking changes in patch releases like 4.0.3.

I will re-apply this change in a later release (likely 4.1).

@remkop remkop reopened this Aug 26, 2019
@remkop remkop modified the milestones: 4.0.3, 4.1 Aug 26, 2019
@gitfineon
Copy link
Contributor Author

Of course, np, ... was able to overwrite it with the i18n properties file

@remkop remkop modified the milestones: 4.2, 4.1 Oct 16, 2019
@remkop remkop modified the milestones: 4.1, 5.0 Nov 18, 2019
@remkop remkop added the theme: usagehelp An issue or change related to the usage help message label May 19, 2020
@remkop remkop modified the milestones: 5.0, 4.7 Feb 21, 2022
@remkop
Copy link
Owner

remkop commented Feb 21, 2022

Thank you for your patience.

This has been fixed in #1579 and #1578
and will be included in the picocli 4.7.0 release.

@remkop remkop closed this as completed Feb 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme: usagehelp An issue or change related to the usage help message type: doc 📘 type: enhancement ✨
Projects
None yet
Development

No branches or pull requests

2 participants