Encode absolute presentation URL if present #1346
Merged
+10
−3
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 |
d-ronnqvist
reviewed
Nov 13, 2025
Tests/SwiftDocCTests/Infrastructure/ExternalReferenceResolverTests.swift
Show resolved
Hide resolved
The `Equatable` implementation of `LinkDestinationSummary` was missing some of the new fields which were added recently. This commit adds them.
Support for absolute URLs in link summaries was added in 7db36ad. It added support for absolute URLs when decoding a link summary, but not when encoding it: https://github.com/swiftlang/swift-docc/blob/cfcd96f0e992af2287661f6a26e8398096f6bc1e/Sources/SwiftDocC/LinkTargets/LinkDestinationSummary.swift#L772-L773 https://github.com/swiftlang/swift-docc/blob/cfcd96f0e992af2287661f6a26e8398096f6bc1e/Sources/SwiftDocC/LinkTargets/LinkDestinationSummary.swift#L728 Both are needed when using an external link resolver, as the external link resolver needs to encode the entity to send to DocC. Fixes rdar://164628218.
anferbui
force-pushed
the
encode-absolute-urls-in-link-summaries
branch
from
05e786c to
40805b0
Compare
Contributor
Author
|
@swift-ci please test |
d-ronnqvist
approved these changes
Nov 13, 2025
Contributor
d-ronnqvist
left a comment
d-ronnqvist
left a comment
There was a problem hiding this comment.
This looks good to me.
Thanks for fixing the == implementation! I had missed that previously.
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.
Bug/issue #, if applicable: rdar://164628218
Summary
Support for absolute URLs in link summaries was added in 7db36ad.
It added support for absolute URLs when decoding a link summary, but not when encoding it:
swift-docc/Sources/SwiftDocC/LinkTargets/LinkDestinationSummary.swift
Lines 772 to 773 in cfcd96f
swift-docc/Sources/SwiftDocC/LinkTargets/LinkDestinationSummary.swift
Line 728 in cfcd96f
Both are needed when using an external link resolver, as the external link resolver needs to encode the entity to send it to DocC.
Dependencies
N/A
Testing
Unit tested.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded[ ] Updated documentation if necessaryN/A