jfmengels/elm-review-documentation

Docs.ReviewLinksAndSections should suggest what seems closest

Open

#14 opened on Sep 25, 2021

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Elm (2 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (8 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

When the rule reports links to unknown things, I think it would be valuable if the rule suggested what is closest to it (using something like the Levenshtein distance).

For an unknown module, suggest the module name with the name that comes closest. For an unknown section, suggest the section from the same module with the name that comes closest.

Contributor guide

Research direction
Investigate the Docs.ReviewLinksAndSections rule implementation and find where unknown links are reported. Add logic to compute Levenshtein distance between the unknown link and known names, and suggest the closest match in the error message.
Tech stack
None
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Elm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60