haskell / haskell/haskell-mode

Make eldoc-mode fully subsume haskell-doc-mode

Open
#1,138 14 comments 1 reaction 0 assignees View on GitHub
well-defined-task
Dominant language
Emacs Lisp
Stars
1.4k
Forks
354
Avg merge
5d 10h
Merged PRs (30d)
2

Description

In light of issues mulled over in #649 and #820 `haskell-doc-mode` should be removed, functionality should be put in `eldoc-mode`. `eldoc` actually works already with `haskell-mode`:

``` el
(set (make-local-variable 'eldoc-documentation-function)
'haskell-doc-current-info)
```
- [ ] find out if the above snippet is all that is needed for `eldoc-mode`
- [ ] implement what is missing
- [ ] write some coverage tests
- [ ] remove functionality that duplicates `eldoc-mode` from `haskell-doc.el`
- [ ] remove mentions of `haskell-doc-mode` from texi
- [ ] remove mentions of `haskell-doc-mode` from wiki
- [ ] remove mentions of `haskell-doc-mode` from all the random wikis and tutorials out there
- [ ] remove mentions of `haskell-doc-mode` from spacemacs (if needed)

Contributor guide

Open the contributing guide

Research direction

Start with haskell-doc.el and the existing eldoc-documentation-function snippet, then inspect any current coverage tests. Determine what eldoc-mode still lacks for haskell-mode, cover it with tests, remove duplicated functionality, and update the texi, wiki, and other mentioned documentation references.

Written by the indexing model from the issue text.

Assessment

Tech stack
emacs-lisp
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.