Description
I am working on a language server for the VHDL language and encountered this limitations of the 'workspace/symbol' response data that I want to bring up here.
VHDL is a language that supports overloading which means there can be several identically named functions in the same file.
The workspace/symbol request offers no way to provide the signature of the function. It is poor UX to show a long list of identically named functions.
The temptation is to put the signature in the name of the symbol itself but this will cause clients such as VSCode to highlight matches in the signature. This behavior is pointing to a lack of separation of concerns where the server is responsible for filtering on the query but clients such as VSCode try to make their own made-up highlighting of matches, related issue: #1674