Skip to content

Commit

Permalink
Fixes #1674: Clarify the query format/syntax for WorkspaceSymbolParams
Browse files Browse the repository at this point in the history
  • Loading branch information
dbaeumer committed Jul 8, 2024
1 parent c9b4656 commit c08a064
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions _specifications/lsp/3.18/workspace/symbol.md
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
6 changes: 6 additions & 0 deletions _specifications/specification-3-16.md
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down

0 comments on commit c08a064

Please sign in to comment.