haskell / haskell/cabal

`cabal haddock <arbitrary package>` produces nothing

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

Description

**Describe the bug** / **To Reproduce**

E.g.

```
$ cabal haddock text
```

Produces nothing and exits with 0. Might be because `text` is only a dependency? But I think it is not unreasonable to expect this to work. The `--help` says:

```
Examples:
cabal haddock pkgname Build documentation for the package named pkgname
```

**Expected behavior**
Some documentation should be produced.

**System information**
- Operating system: NixOS

```
$ cabal --version
cabal-install version 3.10.1.0
compiled using version 3.10.1.0 of the Cabal library
$ ghc --version
The Glorious Glasgow Haskell Compilation System, version 9.4.6
```

Contributor guide

Open the contributing guide

Research direction

No source file or test is named. Start by reproducing `cabal haddock text` with the reported Cabal and GHC versions, then trace how the haddock command resolves a package name versus a dependency. Done means the documented command produces documentation or clearly reports why the package cannot be selected.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.