Show default when flags toggle feature

Open
#12,180 3 comments 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 3 days

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
64/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
haskell
Domain
cli

Research direction

Start by running cabal build --help and compare the paired enable/disable feature flags, including --enable-tests and --disable-tests. Trace where this help output is generated, then update the relevant help text so the default choice is marked consistently and verify the resulting command output.

Written by the indexing model from the issue text.

Description

documentation type: discussion type: enhancement

What is wrong with the docs?
The cabal build --help and other help output shows flags for enabling and disabling features but doesn't say what the default is. Could we indicate which is the default?

   $ cabal build --help
   ...
    --enable-tests                 Enable dependency checking and compilation for
                                   test suites listed in the package description
                                   file.
-   --disable-tests                Disable dependency checking and compilation
+   --disable-tests (default)      Disable dependency checking and compilation
                                   for test suites listed in the package
                                   description file.
Dominant language
Haskell
Stars
1.8k
Forks
766
Avg merge
5d 21h
Merged PRs (30d)
27

Getting set up

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.

More from haskell/cabal

All issues in haskell/cabal

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.