feat: Add override_documentation for type changes. #50
Conversation
This file contains hidden or 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
varungandhi-src
commented
Aug 3, 2022
It is not fully correct yet, because in some cases we emit the SymbolInfo.documentation with wrong type information, and subsequently add override_documentation with the right type information. For such situations, we should overwrite the original docs instead or not emit it in the first place. I will fix that in a subsequent PR.
varungandhi-src
force-pushed
the
vg/override-docs
branch
from
0663783 to
970a4e4
Compare
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.
It is not fully correct yet, because in some cases we emit
the SymbolInfo.documentation with wrong type information, and
subsequently add override_documentation with the right type
information.
For such situations, we should overwrite the original docs
instead or not emit it in the first place.
I will fix that in a subsequent PR. #51
Motivation
Fixes a crash while indexing Homebrew/brew.
Test plan
See included automated tests.