ndmitchell / ndmitchell/hlint

Very large hints returned sometimes

Open
#375 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
1.6k
Forks
210
PR merge metrics
No merged PRs in 30d

Description

If a large function is defined something like

foo x = do
  case x of
     -- many many lines of case matching and processing, where clauses, etc

then the redundant do hint will repeat the entire text for function foo twice, once with the do and once without.

This can result in unwieldy hints, especially when they are presented as a pop-up on hovering in an IDE.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the redundant do hint with the large Haskell function example in the issue and inspect how the hint is rendered. Trace the code that constructs this hint and determine how to avoid repeating the full function while retaining a useful suggestion; done means large hints no longer duplicate the entire function text.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.