Fix the Relationships description in the v2.1.0 notes - #93
Merged
Conversation
The tab was described as listing inbound and outbound references — who uses a type and what it depends on. It resolves neither. `RuntimeRelationships` carries exactly two collections, `subclasses` and `conformingTypes`, and the resolver fills them for four kinds only: a class gets its direct subclasses, a protocol gets its conforming types, and everything else returns `.empty`. The wording dates back to the beta.2 notes and was copied forward through RC.1 into this release unchecked. Replaced with the two lookups that exist, plus the two properties of the result users will notice: it unions across every indexed image rather than the defining one, and images still waiting on background indexing contribute nothing.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the v2.1.0 release notes to accurately describe what the Inspector → Relationships tab actually computes in Runtime Viewer (subclasses for classes, conformers for protocols), correcting prior wording that implied inbound/outbound reference analysis.
Changes:
- Fixes the Highlights bullet to reflect the implemented relationships data.
- Rewrites the “Inspector → Relationships” section to describe the real lookups and their user-visible behavior (cross-image union + gradual fill-in during background indexing).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
The v2.1.0 release notes describe the Relationships tab as listing inbound
references (who uses this type) and outbound references (what this type
depends on). It resolves neither.
RuntimeRelationshipscarries exactly two collections:and
RuntimeRelationshipsResolver.relationships(for:)fills them for fourkinds only — ObjC/Swift class and ObjC/Swift protocol. A class gets its direct
subclasses, a protocol gets its conforming types, anything else returns
.empty. There is no reference analysis anywhere in that path.The wording originates in the
v2.1.0-beta.2notes and was copied forwardthrough
v2.1.0-RC.1into this release without being checked against theimplementation.
Rewritten to the two lookups that exist, plus the two properties of the result
a user will actually notice: the union runs over every indexed image rather
than the target's defining image, and images still waiting on background
indexing contribute nothing, so the list fills in as indexing catches up.
The same wrong sentence is still in
Changelogs/v2.1.0-beta.2.mdandChangelogs/v2.1.0-RC.1.md, along with the GitHub Release notes those twotags published. Left alone here — this PR covers the current stable release.