ndmitchell/hlint

Suggest the right form of HLint ignoring

Open

#1,181 建立於 2020年12月13日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Haskell (1,594 star) (208 fork)batch import
good first issue

描述

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.

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
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.