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.

Sign up for GitHub

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

Jump to bottom

Support custom help messages for completions #5063

Open
ModProg opened this issue Aug 1, 2023 · 1 comment
Open

Support custom help messages for completions #5063

ModProg opened this issue Aug 1, 2023 · 1 comment
Labels
A-completion Area: completion generator C-enhancement Category: Raise on the bar on expectations S-blocked Status: Blocked on something else such as an RFC or other implementation work.

Comments

@ModProg
Copy link
Contributor

ModProg commented Aug 1, 2023

Some shell completions, such as fish and zsh allow displaying a help message.

Currently, we use the short help, but this might not always be appropriate due to the constraints of the completion.

We could consider adding a separate complete_help to any command, argument, or possible value, this would be the first line of the short help by default, but could be overridden either to disable, or to replace with a custom message.

This does pose some complexity as it adds an additional field to everything with a help or about.
@epage epage added C-enhancement Category: Raise on the bar on expectations A-completion Area: completion generator labels Aug 1, 2023
@epage epage mentioned this issue Aug 1, 2023
Open
17 tasks
@epage
Copy link
Member

epage commented Aug 1, 2023

complete_help would be blocked on the plugin system being publicly exposed

@epage epage added the S-blocked Status: Blocked on something else such as an RFC or other implementation work. label Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-completion Area: completion generator C-enhancement Category: Raise on the bar on expectations S-blocked Status: Blocked on something else such as an RFC or other implementation work.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@epage @ModProg