ndmitchell / ndmitchell/hlint

hs-lint.el fails a linter

Open
#489 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Here's some output:

hs-li… 0 warning You should have a section marked ";;; Commentary:" (emacs-lisp-checkdoc)
hs-li… 21 warning You should have a section marked ";;; Code:" (emacs-lisp-checkdoc)
hs-li… 32 warning First sentence should end with punctuation (emacs-lisp-checkdoc)
hs-li… 37 warning First sentence should end with punctuation (emacs-lisp-checkdoc)
hs-li… 42 warning First sentence should end with punctuation (emacs-lisp-checkdoc)
hs-li… 60 warning First sentence should end with punctuation (emacs-lisp-checkdoc)
hs-li… 63 warning All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
hs-li… 68 warning First sentence should end with punctuation (emacs-lisp-checkdoc)
hs-li… 82 28 warning goto-line' is for interactive use only; use forward-line' instead. (emacs-lisp)
hs-li… 103 warning First sentence should end with punctuation (emacs-lisp-checkdoc)
hs-li… 103 warning Argument `buf' should appear (as BUF) in the doc string (emacs-lisp-checkdoc)
hs-li… 119 warning First sentence should end with punctuation (emacs-lisp-checkdoc)

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 with hs-lint.el and run the emacs-lisp-checkdoc and emacs-lisp checks shown in the issue. Review each reported warning, including missing Commentary and Code sections, documentation punctuation, missing doc strings, and goto-line usage. Done means the linter reports no warnings for hs-lint.el.

Written by the indexing model from the issue text.

Assessment

Tech stack
emacs-lisp
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.