fix: correct copy-pasted JSDoc on provideInlineValues method#322701
Open
jachinsamuel wants to merge 1 commit into
Open
fix: correct copy-pasted JSDoc on provideInlineValues method#322701jachinsamuel wants to merge 1 commit into
jachinsamuel wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the internal API documentation in src/vs/editor/common/languages.ts to correct a copy-pasted JSDoc for InlineValuesProvider.provideInlineValues, aligning it with the public API description in src/vscode-dts/vscode.d.ts.
Changes:
- Replaced the incorrect hover-related JSDoc on
provideInlineValueswith an inline-values-specific description.
This file contains hidden or 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
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.
Description
This PR corrects the copy-pasted JSDoc comment above the
provideInlineValuesmethod in theInlineValuesProviderinterface. The comment was copy-pasted fromHoverProviderand incorrectly referenced "hovers being merged", which is not applicable to inline debug values.How to test
Verify that the updated JSDoc in
src/vs/editor/common/languages.tscorrectly describes inline values (mirroring the public API description invscode.d.ts).