Skip to content

Add underscored API documentation comments#909

Merged
Kyle-Ye merged 1 commit into
mainfrom
optimize/documentation_update
Jun 14, 2026
Merged

Add underscored API documentation comments#909
Kyle-Ye merged 1 commit into
mainfrom
optimize/documentation_update

Conversation

@Kyle-Ye

@Kyle-Ye Kyle-Ye commented Jun 14, 2026

Copy link
Copy Markdown
Member

Agent Summary

Adds missing documentation comments for selected underscored public API surfaces.

The update places comments on the primary type or protocol declarations where appropriate, and avoids repeating identical comments on default implementations. It also keeps the wording aligned with OpenSwiftUI naming.

Validation:

  • Ran git diff --check.
  • Checked newly added comments for stale SwiftUI wording and doc:// links.
  • No build was run; this is a Swift documentation-comment-only change.

@github-actions github-actions Bot added area: docs Documentation area label. type: docs Documentation, README, guides, or package index metadata. labels Jun 14, 2026
@Kyle-Ye Kyle-Ye marked this pull request as ready for review June 14, 2026 05:39
@Kyle-Ye Kyle-Ye merged commit b795be3 into main Jun 14, 2026
6 of 7 checks passed
@Kyle-Ye Kyle-Ye deleted the optimize/documentation_update branch June 14, 2026 05:40
@augmentcode

augmentcode Bot commented Jun 14, 2026

Copy link
Copy Markdown
🤖 Augment PR Summary

Summary: This PR improves API documentation coverage for several underscored but public OpenSwiftUI/OpenSwiftUICore types and members.

Changes:

  • Added doc comments to underscored protocols/types like _PerformanceTest, _AnimationModifier, _ColorMatrix, and various layout/effect helpers.
  • Documented underscored member requirements such as Commands._resolve(into:), TransactionKey._valuesEqual(_:_:), and LayoutSubview._trait(key:).
  • Added parameter docs for benchmarking APIs (e.g., scroll testing and benchmark lifecycle hooks).

Technical Notes: Changes are documentation-only and aim to align wording with OpenSwiftUI naming and swift-docc conventions.

🤖 Was this summary useful? React with 👍 or 👎

@augmentcode augmentcode Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 2 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

// MARK: - _PerformanceTest [6.4.41]

/// A performance test that will be executed by PPT.
@available(OpenSwiftUI_v1_0, *)

@augmentcode augmentcode Bot Jun 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PPT is an unexplained acronym here; consider expanding it or linking to the test harness so the rendered docs are understandable outside this repo.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

// MARK: - _ColorMatrix

/// A color matrix. The result of applying to a color is produced by
/// multiplying the color by the square matrix formed by the first

@augmentcode augmentcode Bot Jun 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor grammar issue: “The result of applying to a color…” reads like it’s missing the object (e.g., applying it to a color), which can make the doc sentence confusing.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@codecov

codecov Bot commented Jun 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 26.33%. Comparing base (ec8d089) to head (414b1f6).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #909      +/-   ##
==========================================
- Coverage   26.35%   26.33%   -0.02%     
==========================================
  Files         710      710              
  Lines       49537    49537              
==========================================
- Hits        13053    13048       -5     
- Misses      36484    36489       +5     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation area label. type: docs Documentation, README, guides, or package index metadata.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant