Skip to content

[6.1] Fix regression with edge case where navigator may display wrong data #925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 29, 2025

Conversation

mportiz08
Copy link
Contributor

  • Explanation: Fixes regression where navigator may display wrong tree when provided multiple options from Index JSON
  • Scope: Impacts the sidebar navigator in rare cases
  • Issue: rdar://140370212
  • Risk: Low, small additional code change to make preferred choice when provided multiple trees of data
  • Testing: Unit tests added, manually tested with problematic content and existing content without problematic content
  • Reviewer: Hanqing Huang
  • Original PR: Fix regression with edge case where navigator may display wrong data #916

…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
Copy link
Contributor Author

@swift-ci test

@mportiz08 mportiz08 merged commit d402b19 into swiftlang:release/6.1 Jan 29, 2025
1 check passed
@mportiz08 mportiz08 deleted the 6.1/pr-916 branch January 29, 2025 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants