Add successfully resolved external references to reference index #582
Conversation
This file contains 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
rdar://108974747
|
@swift-ci please test |
ethan-kusters
approved these changes
May 9, 2023
| @@ -206,11 +206,17 @@ struct RenderContentCompiler: MarkupVisitor { | |||
| } | |||
|
|
|||
| mutating func resolveTopicReference(_ destination: String) -> ResolvedTopicReference? { | |||
| if let cached = context.referenceIndex[destination] { | |||
| if let cached = context.referenceIndex[destination] { | |||
| if let node = context.topicGraph.nodeWithReference(cached), !context.topicGraph.isLinkable(node.reference) { | |||
There was a problem hiding this comment.
Why is the change here needed? Was it just missing before?
There was a problem hiding this comment.
I thought that it was needed because the code below does it but now that I think about it I also think that the link resolution would have already done this
There was a problem hiding this comment.
Actually, only MarkupReferenceResolver filters references that are linkable so I guess it's possible for the context to have resolved and saved a reference that isn't linkable.
So in order for the cached and non-cached code paths to behave the same, the cached code path should also check that the reference is linkable.
Co-authored-by: Ethan Kusters <ekusters@apple.com>
|
@swift-ci please test |
d-ronnqvist
added a commit
to d-ronnqvist/swift-docc
that referenced
this pull request
May 9, 2023
…ftlang#582) * Add successfully resolved external references to reference index rdar://108974747 * Undo accidental whitespace change Co-authored-by: Ethan Kusters <ekusters@apple.com>
d-ronnqvist
added a commit
that referenced
this pull request
May 10, 2023
… (#584) * Add successfully resolved external references to reference index rdar://108974747 * Undo accidental whitespace change Co-authored-by: Ethan Kusters <ekusters@apple.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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://108974747
Summary
This change tracks successfully resolved external references the same as successfully resolved local references, enabling them to be looked up in the reference index without going through the link resolution code path again.
Dependencies
None.
Testing
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 necessary