bitwizeshift / bitwizeshift/go-cli

Improve `--help` output formatting

Open
#7 0 comments 0 reactions 0 assignees View on GitHub
cosmetic feature-request
Dominant language
Go
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Description

The current `--help` output format displays the usage information using `[]` and `<>` to indicate optional/required values as POSIX does, but the actual breakdowns in `ARGUMENTS` and `FLAGS` does not. It'd be nice if this was somewhat aligned so that this reads a little more clearly in the usage guidelines.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the code that generates the `--help` output and compare the usage section with the `ARGUMENTS` and `FLAGS` breakdowns. The work is done when optional and required values use consistent `[]` and `<>` formatting throughout the help text.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.