apple / apple/swift-argument-parser

Allow configuration discussion to be moved to end

Open
#159 4 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
Swift
Stars
3.8k
Forks
411
Avg merge
7d 13h
Merged PRs (30d)
17

Description

I know this one is a little tenuous but I thought I'd throw it out there and if you don't like it, it can be as easily closed as any other feature request:

A flag that allows the discussion text (`CommandConfiguration(discussion: "")`) to be displayed at the end of help instead of the beginning so the options are visible to the user in the first screen of `more`/`less`. The current output is heavily weighted towards the style of internal code comments instead of the tooling needs of the end-user, who often wants to review the flags, options, arguments (and okay subcommands) quickly, and then use the tool immediately. This is the pattern used for memory refresh.

Reading the full discussion is more typical for someone who is encountering an issue with the tooling and looking for deeper instruction material, and is more typically secondary to casual use. (see also: "full help")

Contributor guide

Open the contributing guide

Research direction

Start by tracing how CommandConfiguration(discussion: "") is rendered in the help output and how options are ordered. Compare the current discussion-first output with the requested end-of-help placement, including behavior in more/less. Done means an explicit configuration path moves the discussion after the flags, options, arguments, and subcommands without changing the default behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.