Trim the v2.1.0 notes and correct Relationships in the earlier ones - #94
Merged
Conversation
…here The v2.1.0 notes ran 400 lines, most of it cause analysis a reader of release notes did not ask for: why a dyld dependency cycle emptied the protocol list, which csops status word separates two injection target classes, how many event loops a losing MCP instance kept resident, and a Build & Tooling section about dependency pins and branching docs. Fixes now state what was broken in a line each, features state what you can do with them, and the whole file is 169 lines. The upgrade note about the helper reinstall moved up to the header, since it is the one thing in here that asks the reader to do something. Also carries the Relationships correction back into the beta.2 and RC.1 notes, where the inbound/outbound reference wording originated before being copied forward.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the v2.1.0 release notes to be more user-focused by trimming overly detailed explanations in the stable v2.1.0 changelog, and by correcting the description of the Inspector “Relationships” tab in the earlier beta.2 and RC.1 notes to match actual behavior (subclasses + conforming types, not inbound/outbound references).
Changes:
- Trim
Changelogs/v2.1.0.mdto concise, reader-facing release notes while keeping key upgrade action items prominent. - Correct “Inspector → Relationships” wording in
v2.1.0-beta.2andv2.1.0-RC.1changelogs to reflect subclasses/conforming-types behavior. - Align the stable release notes’ highlights and sections with the corrected Relationships description.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| Changelogs/v2.1.0.md | Condenses stable v2.1.0 release notes; keeps upgrade-critical helper reinstall note and corrects/streamlines highlights wording. |
| Changelogs/v2.1.0-RC.1.md | Fixes Relationships description to subclasses/conforming types (removes incorrect reference-analysis wording). |
| Changelogs/v2.1.0-beta.2.md | Fixes Relationships description to subclasses/conforming types; adjusts wording to avoid implying reference analysis. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| - **Background indexing** — the sidebar is ready when you click into it, not seconds later | ||
| - **Inspector → Relationships** — a class's subclasses and a protocol's conforming types, gathered across every indexed binary | ||
| - **Background indexing** — the sidebar is ready when you click into it | ||
| - **Inspector → Relationships** — a class's subclasses, a protocol's conforming types |
| - **Generic type specialization** — inspect Swift generics with concrete arguments filled in | ||
| - **Background indexing** — the sidebar is ready when you click into it, not seconds later | ||
| - **Inspector → Relationships** — see who references a type, and what a type depends on | ||
| - **Inspector → Relationships** — a class's subclasses, a protocol's conforming types |
Comment on lines
16
to
+17
| A new **Relationships** tab sits between *Hierarchy* and *Specialization* and | ||
| shows where a type is referenced across the binaries you have loaded. | ||
| shows what else in the loaded binaries builds on a type. |
Comment on lines
+21
to
+22
| - Works across binaries: matches show up regardless of which dylib defines | ||
| them, as long as their image has been indexed. |
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.
Trim
v2.1.0.md(400 → 169 lines)The notes had grown into a write-up of why each bug happened, which is not
what someone reads release notes for. Removed:
the protocol list, the
csopsstatus words separating two injection targetclasses, the event-loop count a losing MCP instance kept resident, the
ViewModel rebinding behind the Inspector blanking.
documentation indexes, the branching model. None of it is visible to a user.
Fixes now get a line each saying what was broken. Features say what you can do
with them. The helper-reinstall note moved into the header, since it is the one
item that asks the reader to act.
Correct Relationships in
beta.2andRC.1Same correction already applied to
v2.1.0.mdin #93: the tab resolvessubclasses and conforming types, not inbound/outbound references.
beta.2iswhere the wording started before being copied forward.
Published GitHub Release notes for all three tags are updated alongside this.