haskell / haskell/cabal

`cabal haddock` help text reports incorrect behavior for dependencies

Open
#9,247 0 comments 0 reactions 0 assignees View on GitHub
cabal-install: cmd/haddock re: help-text type: bug
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

**Describe the bug**

`cabal help` says:

```
λ ~/Projects/hotel-california/ mattp/basic-exec cabal haddock --help | head -n20
Build Haddock documentation.

# ... snip

Currently, documentation for dependencies is NOT built. This behavior may
change in future.

# snip ...
```

However, when I do `cabal haddock`, it *does* build docs for all dependencies.

**To Reproduce**

Run `cabal haddock` and observe how it builds documentation for dependencies

**Expected behavior**

The help text should agree with the default behavior of the program

**System information**
- Operating system
- `cabal`, `ghc` versions: `cabal-3.10.1.0`

**Additional context**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.