ocaml/merlin

Merlin-lib: return the description of a warning based on its identifier

Open

#1,775 opened on May 29, 2024

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)OCaml (252 forks)github user discovery
good first issue

Repository metrics

Stars
 (1,690 stars)
PR merge metrics
 (Avg merge 20d 1h) (7 merged PRs in 30d)

Description

In order to make https://github.com/ocaml/ocaml-lsp/issues/717, we'd like to add a function to merlin-lib.util to retrieve the description of a warning. The warnings are already located here: https://github.com/ocaml/merlin/blob/master/src/ocaml/utils/warnings.ml

Contributor guide

Research direction
Explore the existing warning definitions in src/ocaml/utils/warnings.ml and add a function to retrieve the description by identifier.
Tech stack
None
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45