haskell / haskell/haskell-mode

Script that checks documentation

Open
#1,287 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Emacs Lisp
Stars
1.4k
Forks
354
Avg merge
5d 10h
Merged PRs (30d)
2

Description

We need a script that checks if documentation has all needed parts up to date:
- [ ] if all documented functions are really in code
- [ ] if all interactive functions are really documented and indexed
- [ ] if keybindings are matching their functions
- [ ] if all keybindings are documented and indexed

Two way checking. Note that to make it checkable in texi there is probably a need for some nice macros.

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are named; start by locating the documentation and keybinding sources and clarifying the intended script and texi macros. Done means bidirectional checks cover documented functions, interactive functions, keybindings, and their indexing, with mismatches reported.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.