Add SymbolInformation.display_name
#158
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Towards #154 Previously, there was no reliable way to get the name of a symbol. You could parse it from the symbol descriptor but that only worked for global symbols (not locals) and was error-prone when the indexer chooses to a special encoding in the symbol for some reason (for example, all-lowercase because symbols are case-insensitive). Now, clients can use `SymbolInformation.display_name` to reliably get the name of a symbol to render in API docs or some other application.
|
cc/ @donsbot I'd love your input here. |
|
Main things I'd check:
Breaking it out like this makes it amenable to search. I might want to find the symbol with queries like:
which would be interpreted as matching any identifier |
varungandhi-src
approved these changes
May 25, 2023
|
@donsbot good point. I updated the docstring to add an example to make it clear that the display name should not contain the fully-qualified scope. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Towards #154
Previously, there was no reliable way to get the name of a symbol. You could parse it from the symbol descriptor but that only worked for global symbols (not locals) and was error-prone when the indexer chooses to a special encoding in the symbol for some reason (for example, all-lowercase because symbols are case-insensitive).
Now, clients can use
SymbolInformation.display_nameto reliably get the name of a symbol to render in API docs or some other application.Test plan
Green CI.