Skip to content

Mention docs on hover feature in README #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 23, 2020
Merged

Mention docs on hover feature in README #209

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b73a81
Mention docs on hover feature in README
georgefst Jul 19, 2020
f8aa985
Add more info on passing -haddock flag
georgefst Jul 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,24 @@ 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:

- 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)

## Installation
Expand Down