Kotlin / Kotlin/kotlinx-cli

Add description to ArgParser

Open
#30 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
951
Forks
71
PR merge metrics
No merged PRs in 30d

Description

It would be nice to be able to provide a description for the ArgParser, that gets printed above or below the `Usage: ...` line in the help message.

This shouldn't be hard to implement, so I could make a PR if you like this idea.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating ArgParser and the code that formats its help message, then inspect how the `Usage: ...` line is produced. The work is done when an ArgParser description can be supplied and is printed above or below that usage line, with coverage for the resulting help output.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.