[5.6] Update LinkDestinationSummary to support multi-language content #64
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
…tlang#54) * Move content into a source language variant structure rdar://83716043 * Update LinkDestinationSummary to match spec changes rdar://83716043 * Move `usr` out of variant substructure since it doesn't vary * Update the spec to reduce the amount of duplicate data. Now, the data continues to be encoded directly in the summary and each variant only sets the information that's different in that source language. * Remove extra closing back-tick in documentation comments * Use an alias to make optionality of variant properties more explicit * Remove trait from main summary element to avoid using it as a language replacement * Small documentation comment refinements
Contributor
Author
|
cc @sara-radi, who is the interim 5.6 branch manager while @franklinsch is on vacation. |
sara-radi
approved these changes
Dec 22, 2021
Contributor
|
@swift-ci please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Rationale: This is an additive change to the LinkableEntities.json spec and
LinkDestinationSummaryimplementation to support multi-language content.Risk: Low.
Risk Detail: This is an isolated change to an opt-in feature that's off by default.
Reward: Low/Medium
Reward Details: For documentation that export their "linkable entities" for other documentation to reference, this change enable that information in include multi-language content.
Original PR: #54
Issue: rdar://83716043
Code Reviewed By: Ethan Kusters
Testing Details: New tests covering changes have been added. Existing tests continue to pass.