haskell / haskell/haskell-language-server
Hover on parameter should display haddock comment
- Dominant language
- Haskell
- Stars
- 3k
- Forks
- 455
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 12
Description
When hovering over a parameter in a function, I want to be able to see the haddock documentation for said parameter.
`thing_inside` has a rich comment, but I always need to manually match the parameter to the type signature and find the haddock comment.
It would be much better, if on hover on `thing_inside`, I would additionally see:
```
The FreeKiTyVars is null <=> all kind variables used in the
kind signature are bound on the left. Reason:
the last clause of Note [CUSKs: complete user-supplied kind signatures]
in GHC.Hs.Decls
```
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the language server's hover handling for function parameters and how Haddock comments are available for those symbols. The issue provides no file or test names, so trace the existing hover behavior first. Done means hovering over a parameter displays its associated Haddock documentation alongside the current information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- developer-experience, devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100