docs(reference): fix non-compiling examples and DocC symbol links (Batch 4)#60
Conversation
…tch 4) Batch 4 of the documentation-accuracy audit (#55). - F9: DocC symbol links resolved to nonexistent symbols — image(source:theme:) -> image(source:theme:spacing:) (MermaidRender.docc) and attachmentString(source:theme:) -> ...(source:theme:spacing:) (EmbeddingInTextViews.docc). - F14: AddingADiagramType scene-lowering signature missing the required measure: parameter (real: DiagramScene.from(_:measure:)). - F16: MermaidRender.docc said the render cache is keyed per (source, appearance); the real RenderKey is (source, theme, spacing). - F17: Theming.docc used a nonexistent NSColor(hex:) initializer; added a small NSColor hex convenience so the brand-theme example compiles. - F20: CHANGELOG 2.2.0 listed diagram(source:format:) among caller-facing entry points, but it is private — dropped it (the public entry points remain). - F25: GettingStarted used view.effectiveAppearance.isDark (no such property); use bestMatch(from: [.aqua, .darkAqua]) == .darkAqua. Closes #55. Co-Authored-By: Claude Opus 4.8 <[email protected]> Claude-Session: https://claude.ai/code/session_014CJYAapHgDn2PWGNABnFtv
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 25 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: bee87d2ac8
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - ``MermaidView`` — a SwiftUI view: give it Mermaid source, it renders. | ||
| - ``MermaidRenderer/image(source:theme:)`` — one call, one native image. | ||
| - ``MermaidRenderer/image(source:theme:spacing:)`` — one call, one native image. | ||
| - ``MermaidRenderer/attachmentString(source:theme:)`` — the diagram as a |
There was a problem hiding this comment.
When the reference docs are built with DocC symbol-link validation, this bullet still points at MermaidRenderer/attachmentString(source:theme:), but the public overload includes the spacing label (attachmentString(source:theme:spacing:) in MermaidRenderer.swift). Since this batch updates the neighboring image link for the same reason, leaving this stale link means the MermaidRender overview can still fail or warn on unresolved symbols.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: bee87d2ac8
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - ``MermaidView`` — a SwiftUI view: give it Mermaid source, it renders. | ||
| - ``MermaidRenderer/image(source:theme:)`` — one call, one native image. | ||
| - ``MermaidRenderer/image(source:theme:spacing:)`` — one call, one native image. | ||
| - ``MermaidRenderer/attachmentString(source:theme:)`` — the diagram as a |
There was a problem hiding this comment.
When the reference docs are built with DocC symbol-link validation, this bullet still points at MermaidRenderer/attachmentString(source:theme:), but the public overload includes the spacing label (attachmentString(source:theme:spacing:) in MermaidRenderer.swift). Since this batch updates the neighboring image link for the same reason, leaving this stale link means the MermaidRender overview can still fail or warn on unresolved symbols.
Useful? React with 👍 / 👎.
1 participant
Batch 4 of the doc-accuracy audit. Closes #55. Each verified against code:
image(source:theme:spacing:),attachmentString(source:theme:spacing:).DiagramScene.from(_:)requiresmeasure:(verifiedDiagramScene+Flowchart.swift:12).(source, theme, spacing), not(source, appearance)(DiagramRenderer.swift:370).NSColor(hex:)doesn't exist; added a hex convenience so the brand-theme example compiles.diagram(source:format:)isprivate(MermaidRenderer.swift:141); removed from the CHANGELOG's caller-facing list.effectiveAppearance.isDarkdoesn't exist; usebestMatch(from: [.aqua, .darkAqua]) == .darkAqua.Docs-only.
🤖 Generated with Claude Code
Need help on this PR? Tag
/codesmithwith what you need. Autofix is disabled.