haskell / haskell/haskell-language-server

HLS should show the module description on hover over an import

Open
#5,023 2 comments 2 reactions 0 assignees View on GitHub
Hackathon type: enhancement
Dominant language
Haskell
Stars
3k
Forks
455
Avg merge
4d 3h
Merged PRs (30d)
12

Description

Image

The module `GHC.Unit.Env` has a rich and descriptive module documentation, but there is right now no way to actually view it from HLS.

### Proposed Solution

On hover on the module declaration and hovering over an import, we should render the haddock module documentation.

I am not sure why we are not doing this yet already, but I think it should be reasonably straight forward.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing HLS hover handling for module declarations and imports, then find how Haddock documentation is represented or rendered. The work is done when hovering either a module declaration or an import displays that module's documentation, including the content described for GHC.Unit.Env.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
developer-experience
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.