Skip to content

Allow using a completion-specific candidate description over the candidate's help message in rust-native completions #5063

Open
@ModProg

Description

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.

Metadata

Assignees

No one assigned

    Labels

    A-completionArea: completion generatorC-enhancementCategory: Raise on the bar on expectationsS-blockedStatus: Blocked on something else such as an RFC or other implementation work.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions