Skip to content

Help us with better command and parameter/flag descriptions #5066

Description

@fdncred

Related problem

Some of our descriptions of commands and parameter descriptions could be more informative. Now that we've added descriptions in our completions, it would be nice to have them be as informative as possible without being too verbose.

Example of command descriptions
Screen Shot 2022-04-01 at 4 12 46 PM

Example of parameter/flag descriptions
Screen Shot 2022-04-01 at 4 13 18 PM

Describe the solution you'd like

We'd like to have helpful, concise descriptions for parameters/flags, and commands.

Describe alternatives you've considered

No response

Additional context and details

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    A:completionsIssues related to tab completioncategory:documentationissues relating to documentationdelightthis feature would delight usersgood first issueGood for newcomershelp wantedstatus: Extra attention is needed

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions