fix formatting of enum values in flag help text by GautamKumarOffical · Pull Request #13730 · cli/cli · GitHub
Skip to content

fix formatting of enum values in flag help text#13730

Open
GautamKumarOffical wants to merge 1 commit into
cli:trunkfrom
GautamKumarOffical:fix-enum-value-formatting
Open

fix formatting of enum values in flag help text#13730
GautamKumarOffical wants to merge 1 commit into
cli:trunkfrom
GautamKumarOffical:fix-enum-value-formatting

Conversation

@GautamKumarOffical

@GautamKumarOffical GautamKumarOffical commented Jun 25, 2026

Copy link
Copy Markdown

Fixes #8349

Enum values in flag docs looked like {created_at|last_accessed_at|size_in_bytes} which was pretty rough on the eyes. Swapped it out for a cleaner format:

-S, --sort <string>   Sort fetched caches: one of "created_at", "last_accessed_at", "size_in_bytes"

Same treatment for error messages - instead of valid values are {asc|desc} it now says expected one of "asc", "desc".

The old format used curly braces with pipes like {asc|desc} which is
hard to read. Now uses a quoted, comma-separated list like
one of "asc", "desc" for better readability in --help output
and error messages.
@GautamKumarOffical GautamKumarOffical requested a review from a team as a code owner June 25, 2026 17:46
@GautamKumarOffical GautamKumarOffical changed the title improve enum value display in flag docs fix formatting of enum values in flag help text Jun 25, 2026
@github-actions github-actions Bot added external pull request originating outside of the CLI core team needs-triage needs to be reviewed unmet-requirements and removed needs-triage needs to be reviewed labels Jun 25, 2026
@github-actions

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external pull request originating outside of the CLI core team unmet-requirements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enum values listed in option docs are poorly formatted

1 participant