apple / apple/swift-argument-parser
Use compact valueName by default
- Dominant language
- Swift
- Stars
- 3.8k
- Forks
- 411
- Avg merge
- 7d 14h
- Merged PRs (30d)
- 15
Description
By default, `ArgumentParser` currently uses a `ArgumentHelp.valueName` derived from the option name. While this is a nice standard default, I think it often leads to overly verbose --help text, and customizing with `ArgumentHelp` makes declaration a little verbose (super kudos for having it possible in v0.0.1 though!).
I think there is an argument to be made for having `ArgumentParser` use a default value name for well-known and common types, for example, using `N` for integral types.
One upside of this is that it helps communicate the expected type.
I can understand if this is perceived to be too much magic, though...
Contributor guide
Research direction
Start by reading ArgumentParser's handling of ArgumentHelp.valueName and the default value name derived from option names. Determine which well-known types should receive compact names such as N, then verify the resulting --help output and settle how the defaults should be configured.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100