Introduce dedicated SignatureDocumentation message type#385
Open
Introduce dedicated SignatureDocumentation message type#385
SignatureDocumentation message type#385Conversation
Replace the reuse of Document for SymbolInformation.signature_documentation with a dedicated SignatureDocumentation message. The new message contains only the relevant fields (language, text, occurrences) and reserves Document's field numbers (1, 3, 6) to maintain wire compatibility with older indexes.
jupblb
force-pushed
the
michal/signature-doc
branch
from
d3d2e5c to
9073268
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
SymbolInformation.signature_documentationpreviously reused theDocumentmessage type, even thoughDocumentis designed to represent a source file on disk (with a "required"relative_path, etc.). This PR introduces a dedicatedSignatureDocumentationmessage with a subset ofDocumentfields.The new message preserves the same protobuf field numbers as
Documentfor the shared fields, so old and new indexes are binary wire-compatible in both directions. TheDocument-only field numbers arereservedinSignatureDocumentationto prevent accidental reuse.This change is not compliant with Protobuf best practices (shouldn't change the type of an existing field) but we're also pre-1.0.
Supersedes #299