Skip to content

Commit df2d696

Browse files
committed
chore(changeset): declare the tombstone-docblock premise correction as a @object-ui/types patch
The rewritten docblocks are on exported members and reach the emitted .d.ts, so the package ships changed bytes (check-changeset-presence.mjs header, "Comment text in src DOES reach a published .d.ts"). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014mXUNuFomfj24w7s1pZzhN
1 parent 54612db commit df2d696

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
'@object-ui/types': patch
3+
---
4+
5+
Correct a stale premise in the published declaration docs of the content-channel tombstones (objectui#9933).
6+
7+
The `body?: never` / `children?: never` docblocks of the components that read neither content channel (objectui#9256), and the `body?: never` docblocks of the components that read `children` (objectui#8284: `box`, `span`, `container`, `flex`, `stack`, `grid`, `scroll-area`, `form`, `toggle`), justified each tombstone by saying that `body` (and `children`) "are inherited-and-optional from `BaseSchema`, whose own docblock admits 'some components use `children` instead of `body`'". Since objectui#6771 retired the `body` spelling, that opening clause is false in the present tense: `BaseSchema.body` is `never`, and `BaseSchema`'s own docblock no longer admits the two-spelling ambiguity. These docblocks ship in the emitted `.d.ts`, so a declarations reader was taught the premise the retirement removed.
8+
9+
Each paragraph now dates the inherited-and-optional state to before its own tombstone and states the present: `BaseSchema` refuses `body` itself and still declares `children`, which the neither-channel tombstone refuses. The rest of each docblock — what the renderer reads, how that was measured, and the `@deprecated` remedy — is unchanged.
10+
11+
Comment text only: no declaration, member, type or export moves, and every authored document type-checks and parses exactly as it did before.

0 commit comments

Comments
 (0)