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

AutoComplete.GenerateCompletion generated man page summary improvement #1124

Closed
remkop opened this issue Jul 7, 2020 · 0 comments
Closed
Labels
theme: codegen An issue or change related to the picocli-codegen module type: doc 📘
Milestone

Comments

@remkop
Copy link
Owner

remkop commented Jul 7, 2020

The generated man page for generate-completion (AutoComplete.GenerateCompletion) in the picocli documentation (build\picocli-generated-docs\generate-completion.adoc) has the following summary:

generate-completion - Generate bash/zsh completion script for generate-completion.

During the picocli 4.4 release, I manually changed this to the following:

generate-completion - Generate bash/zsh completion script for the root command of this command.

See if we can automate this.


One idea is to create a command in picocli-codegen that has @Command(name = "the root command of this command"), and change picocli-codegen/build.gradle task generateManpageAsciiDoc to point to this command instead of to picocli.AutoComplete$GenerateCompletion.

@remkop remkop added type: doc 📘 theme: codegen An issue or change related to the picocli-codegen module labels Jul 7, 2020
@remkop remkop added this to the 4.5 milestone Jul 7, 2020
@remkop remkop closed this as completed Jul 7, 2020
@remkop remkop modified the milestones: 4.5, 4.4.1 Jul 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme: codegen An issue or change related to the picocli-codegen module type: doc 📘
Projects
None yet
Development

No branches or pull requests

1 participant