Skip to content

Cleanup completion details docs #952

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

Merged
merged 3 commits into from
Mar 11, 2024
Merged

Conversation

zth
Copy link
Collaborator

@zth zth commented Mar 10, 2024

Closes #469 and #837

This does 2 things:

  • Does a major clean up of the details and docs generated for completion items.
  • Implements the LSP completionResolve request so we can resolve (some) completion item docs async. Then via that implement file module docs resolution.

This is a big diff test wise, because I've changed quite a few things wrt details and docs. It might not all be perfect yet, but it's going to be much much better than what we have today already, given what mess the details and docs for completion items are today.

Example of file module level docs:
image

@zth zth requested a review from cristianoc March 10, 2024 22:12
@@ -74,20 +74,20 @@ Resolved opens 1 pervasives
"label": "version",
"kind": 5,
"tags": [],
"detail": "version?: int\n\ntype jsxConfig = {version: int, module_: string, mode: string}",
"documentation": null
"detail": "int",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change in detail intentional?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, intentional.

@zth zth force-pushed the cleanup-completion-details-docs branch from 0d70ec7 to 9b80982 Compare March 11, 2024 09:50
@zth zth merged commit c692e48 into master Mar 11, 2024
@zth zth deleted the cleanup-completion-details-docs branch March 11, 2024 09:58
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

Successfully merging this pull request may close these issues.

Show docs for file modules on type hint
2 participants