Skip to content

Commit

Permalink
Add more info on passing -haddock flag
Browse files Browse the repository at this point in the history
  • Loading branch information
georgefst committed Jul 20, 2020
1 parent 0b73a81 commit f8aa985
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,23 @@ This is *very* early stage software.

![Eval](https://i.imgur.com/bh992sT.gif)

- Type information and documentation on hover. Note that currently, in order for docs to be displayed for dependencies, they must have been built with GHC's `-haddock` flag. This can be achieved in a number of ways, such as `cabal configure --ghc-options=-haddock`.
- Type information and documentation on hover. Note that currently, in order for docs to be displayed for dependencies, they must have been built with GHC's `-haddock` flag:

- For cabal:
- Add to your global config file (e.g. `~/.cabal/config`):
```
program-default-options
ghc-options: -haddock
```
- Or, for a single project, run `cabal configure --ghc-options=-haddock`

- For stack, add to global `$STACK_ROOT\config.yaml`, or project's `stack.yaml`:
```
ghc-options:
"$everything": -haddock
```

This will cause compilation errors if a dependency contains invalid Haddock markup, though in a future version of GHC (hopefully 8.12), [these will be demoted to warnings](https://gitlab.haskell.org/ghc/ghc/-/merge_requests/2377).

- Many more (TBD)

Expand Down

0 comments on commit f8aa985

Please sign in to comment.