Add docs to signature help #2009
Merged
+1,038
−49
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation support to signature help responses in the language server. When a function or method has JSDoc comments, those comments are now included in the signature help information displayed to users.
Key Changes
- The language server now extracts and formats JSDoc comments from function/method declarations
- Documentation is provided in the client's preferred format (markdown or plaintext)
- Client capabilities are checked to determine the appropriate documentation format
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
internal/lsp/server.go |
Added getSignatureHelpDocumentationFormat function to extract client's preferred documentation format from initialization params and pass it to signature help provider |
internal/ls/signaturehelp.go |
Modified signature help generation to extract JSDoc comments from declarations and include them in the response with proper formatting |
internal/fourslash/fourslash.go |
Updated default test capabilities to support markdown documentation in signature help |
testdata/baselines/reference/fourslash/signatureHelp/*.baseline |
Updated test baselines showing documentation now appears in signature help responses |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
jakebailey
commented
Nov 3, 2025
Comment on lines
+304
to
+309
| ParameterInformation: &lsproto.ClientSignatureParameterInformationOptions{ | ||
| LabelOffsetSupport: ptrTrue, | ||
| }, | ||
| ActiveParameterSupport: ptrTrue, | ||
| }, | ||
| ContextSupport: ptrTrue, |
There was a problem hiding this comment.
We are not actually checking these correctly currently (different PR).
sheetalkamat
approved these changes
Nov 3, 2025
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.
These were missing; noticed while working on #1998.
Better viewed without whitespace: https://github.com/microsoft/typescript-go/pull/2009/files?w=1