diff --git a/protocol/src/common/protocol.semanticTokens.ts b/protocol/src/common/protocol.semanticTokens.ts index 1d5611cc5..c5f800be3 100644 --- a/protocol/src/common/protocol.semanticTokens.ts +++ b/protocol/src/common/protocol.semanticTokens.ts @@ -174,11 +174,14 @@ export interface SemanticTokensClientCapabilities { dynamicRegistration?: boolean; /** - * Which requests the client supports and might send to the server. Please - * note that clients might not show semantic tokens or degrade some of the - * user experience if a full request is not provided by a server but - * advertised by the client. A client might for example need all semantic - * tokens to color a minimap correctly. + * Which requests the client supports and might send to the server + * depending on the server's capability. Please note that clients might not + * show semantic tokens or degrade some of the user experience if a range + * or full request is advertised by the client but not provided by the + * server. If for example the client capability `requests.full` and + * `request.range` are both set to true but the server only provides a + * range provider the client might not render a minimap correctly or might + * even decide to not show any semantic tokens at all. */ requests: { @@ -194,6 +197,7 @@ export interface SemanticTokensClientCapabilities { * the server provides a corresponding handler. */ full?: boolean | { + /** * The client will send the `textDocument/semanticTokens/full/delta` request if * the server provides a corresponding handler.