haskell / haskell/haskell-language-server

Display Haddock diagnostics

Open
#4,097 1 comment 4 reactions 0 assignees View on GitHub
type: enhancement
Dominant language
Haskell
Stars
3k
Forks
455
Avg merge
2d 19h
Merged PRs (30d)
11

Description

## Is your enhancement request related to a problem? Please describe.

Haddock produces various warnings that are somewhat useful. For example, it will tell you if it cannot figure out where to link something to, which often indicates a typo.

These warnings are rarely noticed, because the only time you see them is when you run `cabal haddock` (and the format is terrible). Surfacing them in HLS would be pretty helpful.

## Describe the solution you'd like

Haddock warnings (and errors?) appear in HLS like normal diagnostics.

## Additional context

I have no idea how hard it is to get these. I think we are running haddock (if `documentation: true` is set), so presumably we should be able to get the warnings too.

In addition, I notice that the warnings printed out by haddock on the CLI don't even have locations (!!!), so we might have to work on Haddock to get the information we need.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.