[5.7] improve detection for inherited symbol references #294
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
Contributor
Author
|
@swift-ci Please test |
franklinsch
approved these changes
Jun 13, 2022
rdar://93203894 Symbols for operator functions that include multiple dots (e.g. the ClosedRange `...` operator) are currently curated into an unnamed "Implementations" section due to improper string splitting behavior. This enhances the detection two ways: 1. For symbols where the "source origin" is available in our given symbol graphs, it loads the name information from the parent symbol. 2. For symbols where the "source origin" is not available, it improved the string splitting behavior by dropping empty-string components before reading names from it. This allows Comparable and Equatable implementations to curate their inherited operators properly.
QuietMisdreavus
force-pushed
the
5.7/origin-split
branch
from
ed1f26b to
544264f
Compare
Contributor
Author
|
Rebased. @swift-ci Please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Cherry-pick of #257
Explanation: Symbols from ellipsis-style operators (e.g. the
...operator fromEquatable) are currently improperly sorted into an unnamed "Implementations" page. This PR enhances the default implementations curation by attempting to look up a symbol'ssourceOrigininformation, or discarding empty-string components in the symbol name if it fails to look up.Scope: Affects rendering documentation for Swift symbols with Equatable conformances. The fix should allow affected symbols both in the same module and from other modules to get correct default-implementation pages.
Radar: rdar://93203894
Risk: Low. The curation of "default implementations" sections will fall back to organizing the symbols directly into the parent's page if the lookup fails entirely, so no information is lost.
Testing: A test has been added to ensure that ellipsis operator symbols are properly curated into their appropriate protocol's page. Existing automated tests still pass.