Skip to content

docs: Document pause point contracts and raw capture APIs in skills#1718

Merged
hatayama merged 1 commit into
feat/pause-point-observabilityfrom
feat/pause-point-skill-docs
Jul 12, 2026
Merged

docs: Document pause point contracts and raw capture APIs in skills#1718
hatayama merged 1 commit into
feat/pause-point-observabilityfrom
feat/pause-point-skill-docs

Conversation

@hatayama

@hatayama hatayama commented Jul 12, 2026

Copy link
Copy Markdown
Owner

Refs: 2026-07-12_uloop検証フィードバック改善 実装計画.md#PR 2-4 (C-1〜C-4)

Summary

  • Pause-point skill now documents pre-line CapturedVariables vs post-interrupt execute-dynamic-code state (C-1).
  • Hit preconditions clarify that PressEdgeObserved=true does not guarantee logic reached the pause line (C-2).
  • Enable --timeout-seconds lifetime origin is called out at enable time (C-3; await timeout wording was already present).
  • Marker types (enable-pause-point vs UloopPausePoint.Pause) and raw capture APIs (TryGetCapturedValue, GetCapturedNames, GetCapturedPausePointId) are documented (C-4).
  • Execute-dynamic-code skill cross-links the raw capture API for live references while paused.

User Impact

  • Agents get uloop-specific contracts for pause-point evidence without generic debugging prose.
  • While Unity is paused on a hit, agents can discover how to read live captured references via UloopPausePoint.TryGetCapturedValue.

Test plan

  • uloop skills install --claude --agents regenerated .claude/skills and .agents/skills from source SKILL.md
  • Source and generated copies are byte-synced for the two updated skills

Made with Cursor

Review in cubic

Clarify pre-line CapturedVariables vs post-interrupt execute-dynamic-code
state, hit preconditions, enable timeout origin, marker types, and
UloopPausePoint.TryGetCapturedValue while paused.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: fdb8e4a5-97a5-4d8e-b00f-5771340ee02b

📥 Commits

Reviewing files that changed from the base of the PR and between f278b69 and 6fef323.

📒 Files selected for processing (6)
  • .agents/skills/uloop-execute-dynamic-code/SKILL.md
  • .agents/skills/uloop-pause-point/SKILL.md
  • .claude/skills/uloop-execute-dynamic-code/SKILL.md
  • .claude/skills/uloop-pause-point/SKILL.md
  • Packages/src/Editor/CliOnlyTools~/PausePoint/Skill/SKILL.md
  • Packages/src/Editor/FirstPartyTools/ExecuteDynamicCode/Skill/SKILL.md

📝 Walkthrough

Walkthrough

Documentation updates clarify pause-point timing, captured-variable snapshot semantics, live capture APIs, marker types, hit preconditions, and guidance for inspecting locals through execute-dynamic-code.

Changes

Pause-point inspection documentation

Layer / File(s) Summary
Pause timing and capture semantics
.agents/skills/uloop-pause-point/SKILL.md, .claude/skills/uloop-pause-point/SKILL.md, Packages/src/Editor/CliOnlyTools~/PausePoint/Skill/SKILL.md
Documents enable-time timeout behavior and distinguishes pre-line CapturedVariables snapshots from post-interrupt dynamic-code state.
Live capture access and hit conditions
.agents/skills/uloop-pause-point/SKILL.md, .claude/skills/uloop-pause-point/SKILL.md, Packages/src/Editor/CliOnlyTools~/PausePoint/Skill/SKILL.md
Documents live captured-reference APIs, holder lifetime, marker types, and pause-hit preconditions.
Dynamic-code inspection guidance
.agents/skills/uloop-execute-dynamic-code/SKILL.md, .claude/skills/uloop-execute-dynamic-code/SKILL.md, Packages/src/Editor/FirstPartyTools/ExecuteDynamicCode/Skill/SKILL.md
Directs inspection of locals and intermediate values through source pause points and UloopPausePoint capture APIs rather than reconstructing pre-line values with dynamic code alone.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: documenting pause point contracts and raw capture APIs in skills.
Description check ✅ Passed The description directly matches the documented pause-point semantics, raw capture APIs, and generated skill sync changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/pause-point-skill-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant