Skip to content

Commit e91fac9

Browse files
authored
Fixes #1674: Clarify the query format/syntax for WorkspaceSymbolParams (#1977)
1 parent c9b4656 commit e91fac9

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

_specifications/lsp/3.18/workspace/symbol.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,12 @@ interface WorkspaceSymbolParams extends WorkDoneProgressParams,
104104
/**
105105
* A query string to filter symbols by. Clients may send an empty
106106
* string here to request all symbols.
107+
*
108+
* The `query`-parameter should be interpreted in a *relaxed way* as editors
109+
* will apply their own highlighting and scoring on the results. A good rule
110+
* of thumb is to match case-insensitive and to simply check that the
111+
* characters of *query* appear in their order in a candidate symbol.
112+
* Servers shouldn't use prefix, substring, or similar strict matching.
107113
*/
108114
query: string;
109115
}

_specifications/specification-3-16.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3272,6 +3272,12 @@ interface WorkspaceSymbolParams extends WorkDoneProgressParams,
32723272
/**
32733273
* A query string to filter symbols by. Clients may send an empty
32743274
* string here to request all symbols.
3275+
*
3276+
* The `query`-parameter should be interpreted in a *relaxed way* as editors
3277+
* will apply their own highlighting and scoring on the results. A good rule
3278+
* of thumb is to match case-insensitive and to simply check that the
3279+
* characters of *query* appear in their order in a candidate symbol.
3280+
* Servers shouldn't use prefix, substring, or similar strict matching.
32753281
*/
32763282
query: string;
32773283
}

0 commit comments

Comments
 (0)