vscode: align typings for provideHover #11862
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes eclipse-theia#11827 Contributed on behalf of STMicroelectronics Change-Id: I328a77cb1a795ada070e11ba3668a96fec00a354 Signed-off-by: Philip Langer <[email protected]>
planger
force-pushed
the
planger/issues/11827
branch
from
284159a to
e7a1145
Compare
msujew
approved these changes
Nov 11, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it does
Aligns the typings of
HoverProvider.provideHoverwith the API of VS Code.This change also updates the documentation to include the token parameter in the signature of the hover provider examples. Technically, this isn't necessary, but for the sake of completeness, I thought it makes sense.
Fixes #11827
Contributed on behalf of STMicroelectronics
How to test
This isn't really a breaking change and only impacts the external extension API, which isn't used directly (I assume) anyway, as people most likely implement against the VS Code API anyway. Also, this method is never invoked directly from within Theia too. So there is nothing really to test, imho.
I locally confirmed that this change makes the report happy.
Review checklist
Reminder for reviewers