ndmitchell/hlint

Suggest the right form of HLint ignoring

Open

#1,181 opened on Dec 13, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (1,594 stars) (208 forks)batch import
good first issue

Description

Currently we recommend three forms at https://github.com/ndmitchell/hlint/blob/master/README.md#ignoring-hints. We should adjust the documentation to only recommend {- HLINT -} style ignores (but note the other two exist), and use HLint to encourage people to switch to the new form.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests updating the README.md file in the hlint repository to recommend only the `{ HLINT }` style of ignoring hints, while noting the other two forms exist. The current documentation at the linked README section lists three forms. The contributor should edit the relevant section, possibly adding a note about a future HLint rule to encourage the new style. No code changes are needed, only documentation updates.