docs(ui): note content controls in entityAt hit types (SD-3313)#3573
Conversation
The entityAt JSDoc said the supported hit types are comment and trackedChange,
but content controls are returned too: ViewportEntityHit includes
{ type: 'contentControl', scope?, tag? }, emitted from data-sdt-id (entity-at.ts).
Correct the supported-types list and add data-sdt-id to the painter
data-attribute examples.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
cubic analysis
No issues found across 1 file
Linked issue analysis
Linked issue: SD-3313: docs: correct pointer hit-testing comments to include content controls
| Status | Acceptance criteria | Notes |
|---|---|---|
| ✅ | JSDoc for entityAt lists contentControl as a supported hit type and notes it carries scope and tag | The diff replaces the sentence that previously listed only comment and trackedChange with a paragraph that includes 'contentControl' and mentions 'scope' and 'tag'. This directly addresses the issue's core request to correct the comments. |
| ✅ | Documentation/examples reference the painter data-attribute `data-sdt-id` so docs match actual returned hits | The diff adds `data-sdt-id` to the earlier paragraph listing data attributes and the PR description says painter data-attribute examples were updated to include it. |
Tip: cubic could auto-approve low-risk PRs like this, if it thinks it's safe to merge. Learn more
Re-trigger cubic
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
🎉 This PR is included in superdoc-cli v0.15.0 The release is available on GitHub release |
|
🎉 This PR is included in superdoc-sdk v1.14.0 |
|
🎉 This PR is included in @superdoc-dev/mcp v0.10.0 The release is available on GitHub release |
|
🎉 This PR is included in superdoc v1.38.0 The release is available on GitHub release |
|
🎉 This PR is included in @superdoc-dev/react v1.9.0 The release is available on GitHub release |
|
🎉 This PR is included in vscode-ext v2.10.0 |
2 participants
A small docs/comment correction.
ui.viewport.entityAt(andcontextAt, which composes it) return content-control hits -ViewportEntityHitincludes{ type: 'contentControl', scope?, tag? }, emitted fromdata-sdt-idin entity-at.ts - but theentityAtJSDoc still said the supported hit types are onlycommentandtrackedChange. Corrects the list and addsdata-sdt-idto the painter data-attribute examples so the guidance matches what the helper actually returns.Comment-only; no behavior change.