haskell / haskell/cabal

Cabal docs lack description of program-options section

Open
#5,227 0 comments 0 reactions 0 assignees View on GitHub
cabal-install: v2-build system documentation type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

`new-build` appears to now support a `program-options` stanza to specify flags for programs like haddock and preprocessors (for example, see the cabal.project file in this repo). But this stanza is not documented or described anywhere on readthedocs.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the repository's Read the Docs content and the cabal.project example mentioned in the issue to confirm how the program-options stanza is used. Document the stanza, its purpose for tools such as haddock and preprocessors, and a representative example; it is done when this behavior is described on Read the Docs.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.