dotnet / dotnet/command-line-api

Help layout improvements

Open
#1,523 4 comments 0 reactions 0 assignees View on GitHub
Area-Help
Dominant language
C#
Stars
3.7k
Forks
428
PR merge metrics
No merged PRs in 30d

Description

Suggesting couple of improvements for help layout

1. In case the option has many suggestions, the first column in layout becomes wide and layout is not very readable. Consider some shortcuts for these case, example,
Actual: `--my-option `
Suggested: `--my-option ` or `--my-option ` + list all possible values in descriptions etc.

2. Consider better representation when option default value is set to empty string.
Actual: `[default: ]` which is confusing as might be read as no default value.
Suggested `[default:]` or similar

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.