Fix bug where symbols would get the framework name show up twice in the availability badges. #922
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
… show up twice in the avaialbility badges. When a framework had a display name different to the symbol name both variantions would appear as availability badges in symbols that were declared in extensions of that same framework, resulting in odd availaiblity information. rdar://126713717
|
@swift-ci please test |
|
Should the framework name show up once after this fix? In the 2nd screenshot there's no longer any module availability item. |
No. Per this change (https://github.com/apple/swift-docc/pull/732/files#diff-68ec34e58e2102fa55684b18f310a856fd3220cf919e869bca4ad5f179ac1f14R1206) it should only appear with external related modules. |
d-ronnqvist
approved these changes
May 23, 2024
|
@swift-ci please test |
patshaughnessy
approved these changes
May 23, 2024
|
@swift-ci please test |
sofiaromorales
added a commit
to sofiaromorales/swift-docc
that referenced
this pull request
May 23, 2024
… show up twice in the avaialbility badges. (swiftlang#922) When a framework had a display name different to the top-level symbol name, both variations would appear as availability badges in the symbols that were declared in extensions of that same framework, resulting in odd availability information. rdar://126713717
sofiaromorales
added a commit
that referenced
this pull request
May 23, 2024
… show up twice in the avaialbility badges. (#922) (#927) When a framework had a display name different to the top-level symbol name, both variations would appear as availability badges in the symbols that were declared in extensions of that same framework, resulting in odd availability information. rdar://126713717
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Bug/issue #, if applicable: 126713717
Summary
When a framework had a display name different to the top level symbol name both variations would appear as availability badges in the symbols that were declared in extensions of that same framework, resulting in odd availability information.
Before the fix:
After the fix:
This was caused by the logic introduced here:
https://github.com/apple/swift-docc/pull/732/files#diff-68ec34e58e2102fa55684b18f310a856fd3220cf919e869bca4ad5f179ac1f14R1206
Dependencies
N/A
Testing
Steps:
Foosymbol does not show the framework name.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeededAvailabilityBug.docc.zip