From c08a06405f0a767052fefa56e67d4224995389ac Mon Sep 17 00:00:00 2001 From: Dirk Baeumer Date: Mon, 8 Jul 2024 21:15:42 +0200 Subject: [PATCH] Fixes #1674: Clarify the query format/syntax for WorkspaceSymbolParams --- _specifications/lsp/3.18/workspace/symbol.md | 6 ++++++ _specifications/specification-3-16.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/_specifications/lsp/3.18/workspace/symbol.md b/_specifications/lsp/3.18/workspace/symbol.md index 3c1b4baeb..a0d749b76 100644 --- a/_specifications/lsp/3.18/workspace/symbol.md +++ b/_specifications/lsp/3.18/workspace/symbol.md @@ -104,6 +104,12 @@ interface WorkspaceSymbolParams extends WorkDoneProgressParams, /** * A query string to filter symbols by. Clients may send an empty * string here to request all symbols. + * + * The `query`-parameter should be interpreted in a *relaxed way* as editors + * will apply their own highlighting and scoring on the results. A good rule + * of thumb is to match case-insensitive and to simply check that the + * characters of *query* appear in their order in a candidate symbol. + * Servers shouldn't use prefix, substring, or similar strict matching. */ query: string; } diff --git a/_specifications/specification-3-16.md b/_specifications/specification-3-16.md index 4e62fb07d..6b49c857f 100644 --- a/_specifications/specification-3-16.md +++ b/_specifications/specification-3-16.md @@ -3272,6 +3272,12 @@ interface WorkspaceSymbolParams extends WorkDoneProgressParams, /** * A query string to filter symbols by. Clients may send an empty * string here to request all symbols. + * + * The `query`-parameter should be interpreted in a *relaxed way* as editors + * will apply their own highlighting and scoring on the results. A good rule + * of thumb is to match case-insensitive and to simply check that the + * characters of *query* appear in their order in a candidate symbol. + * Servers shouldn't use prefix, substring, or similar strict matching. */ query: string; }