Fix regression with edge case where navigator may display wrong data #916
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
This addresses a rare edge case where the Index JSON contains multiple top-level root nodes for distinct trees of navigation data. While that shouldn't normally happen in practice, we would like to prefer the tree with a containing module if available instead of always using the first tree provided in the array.
hqhhuang
approved these changes
Dec 3, 2024
|
@swift-ci test |
mportiz08
added a commit
to mportiz08/swift-docc-render
that referenced
this pull request
Jan 29, 2025
…wiftlang#916) This addresses a rare edge case where the Index JSON contains multiple top-level root nodes for distinct trees of navigation data. While that shouldn't normally happen in practice, we would like to prefer the tree with a containing module if available instead of always using the first tree provided in the array. Resolves: rdar://140370212
mportiz08
added a commit
that referenced
this pull request
Jan 29, 2025
…916) (#925) This addresses a rare edge case where the Index JSON contains multiple top-level root nodes for distinct trees of navigation data. While that shouldn't normally happen in practice, we would like to prefer the tree with a containing module if available instead of always using the first tree provided in the array. Resolves: rdar://140370212
3 tasks
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: 140370212
Summary
This re-introduces logic removed by #904 that was needed to handle an edge case where the navigator needs to decide between data for 2 distinct navigation trees in the rare scenario where it is provided in the IndexJSON by DocC.
There will usually only be data for a single tree provided, but in the rare scenario where multiple are provided, we should prefer the tree with the
"module"root.Testing
Steps:
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
npm test, and it succeeded