pcapriotti / pcapriotti/optparse-applicative

More advanced flag help support

Open
#495 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
959
Forks
123
Avg merge
3d 19h
Merged PRs (30d)
1

Description

While looking at how other programs handle flags I found some special cases:

  1. --[no-]xxxx, which is a pair of flags to override a boolean value, with one help and different resulting values.
    listing them both would also be ok (--xxxx, --no-xxxx)
    So this is a request of having one help for multiple options.
  2. -Wxxx, which is often used to enable warnings in compilers,
    -W as a short flag is trivial, but we want to have multiple help pages per option with expanded valid values.

So I would like help pages not having to be in a 1:1 relation with options.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by reviewing how options and help pages are represented, then determine how one help page can serve --xxxx/--no-xxxx and how -Wxxx can expose expanded values. Done means both requested cases are supported without requiring a one-to-one relationship between options and help pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.