Add SymbolInformation.signature_documentation
#159
Conversation
Towards #154 Previously, SCIP clients had to parse markdown from the `SymbolInformation.documentation` field to display only the signature information of a symbol (for example, method parameters and return type). With the new `SymbolInformation.signature_documentation` field, indexers can now emit more structured information about the signature of a class/method including optional hyperlinks to the referenced symbols.
|
cc/ @donsbot I'd love your thought on this approach. I'm open for suggestions on an alternative encoding that |
| // introduced to support `SymbolInformation.signature_documentation`, but it | ||
| // can be used for other purposes as well, for example testing or when working | ||
| // with virtual/in-memory documents. | ||
| string text = 5; |
There was a problem hiding this comment.
what about "content" instead of "text"? don't have a strong preference either way.
There was a problem hiding this comment.
I went with text to mirror TextDocumentItem.text in LSP (https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentItem) and Document.getText() in VS Code. I'm personally fine either way but think it's a safe choice to stick with LSP terminology when appropriate.
Towards #154
Previously, SCIP clients had to parse markdown from the
SymbolInformation.documentationfield to display only the signature information of a symbol (for example, method parameters and return type).With the new
SymbolInformation.signature_documentationfield, indexers can now emit more structured information about the signature of a class/method including optional hyperlinks to the referenced symbols.Test plan
Green CI.