Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
xvw opened this issue May 29, 2024 · 1 comment
Open

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

xvw opened this issue May 29, 2024 · 1 comment

Comments

@xvw
Copy link
Collaborator

xvw commented May 29, 2024

In order to make ocaml/ocaml-lsp#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

@PizieDust
Copy link
Contributor

Merlin has a command syntax-doc that returns information about certain syntax. I wonder if this will be a good use case for this issue given that we want to return information about the warning to the user.
To do so, a good place to start will be to include the description we want here: https://github.com/ocaml/merlin/blob/master/src/analysis/syntax_doc.ml
This way, when the user has the syntax-doc feature activated on their editor, they will be able to see the description each time they hover on the warning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants