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

Add a custom query for documentation #1244

Open
pitag-ha opened this issue Apr 30, 2024 · 1 comment
Open

Add a custom query for documentation #1244

pitag-ha opened this issue Apr 30, 2024 · 1 comment
Assignees

Comments

@pitag-ha
Copy link
Member

Let's add a query that returns the documentation of a given identifier or of the identifier at a given position.

Current situation

Currently, the only way to retrieve documentation in OCaml LSP is via the hover query, which also returns type information and, potentially, more information.

Why to improve that

Particularly in non-visual editors such as Emacs and Vim, users will also want to access the documentation without extra information such as type information.

How to implement it

The LSP protocol doesn't have a dedicated documentation query. So, we'll need to implement a custom query for this. That custom query can mirror what Merlin server's document query does.

@pitag-ha
Copy link
Member Author

Cc @3Rafal

@3Rafal 3Rafal self-assigned this May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants