Skip to content

finding(components): navigation-overlay.tsx's file-header @example still teaches the objectName: schema.objectName spelling PR #7648 retired #7787

Description

@claude

Found by the first run of the gate built for objectui#7652. Measured, not fixed — the gate PR deliberately does not touch the prose, and carries this file as its one KNOWN_HAND_SPELLINGS entry so the ledger points at this card.

What is true today (measured on origin/main 2fcefb955)

packages/components/src/custom/navigation-overlay.tsx opens with a file-header block documenting NavigationOverlay. Its @example teaches the call it works with:

 * const nav = useNavigationOverlay({
 *   navigation: schema.navigation,
 *   objectName: schema.objectName,
 * });

objectName: schema.objectName is the exact spelling objectui#7638 was filed about and PR #7648 removed from useNavigationOverlay's own doc block, replacing it with resolveRecordSourceObjectName(schema, dataConfig) plus five paragraphs explaining why. That fix did not reach this file, and nothing pointed at it: it is a different file, a different package, and the block documents a different symbol.

Three call sites now pass that slot through the shared reader — packages/plugin-calendar/src/ObjectCalendar.tsx, packages/plugin-grid/src/ObjectGrid.tsx, packages/plugin-tree/src/ObjectTree.tsx — so this example is the last place in packages/ that still teaches the retired spelling.

Why it is a finding and not a filed defect

No runtime behaviour changes: it is a comment. What it costs is what objectui#7652 measured about this whole class — an example is what the next call site is copied from, so prose that outlives the ruling re-seeds the copies. This one is now the only surviving seed. Severity is for triage.

What a fix looks like

One line, plus the sentence the hook's own doc block already carries: point the example at resolveRecordSourceObjectName(schema, dataConfig) from @object-ui/core, and delete the row from KNOWN_HAND_SPELLINGS in scripts/check-doc-example-shared-reader.mjs in the same change — the gate reddens if the ledger names a file it no longer finds, so the two cannot drift apart.

Not addressed here, and out of scope for the gate PR: objectui#7638 remains as it is, and no other prose was touched.

Refs: objectui#7652 (the gate, and the card that measured the class) · objectui#7638 (the same spelling, in the hook's own doc block) · objectui#7627 (the shared reader) · PR #7648 (the fix that did not reach this file).


Generated by Claude Code

Activity

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationdomain:uiobjectui ui stream: fix lands on the published library or apps — objectui execution seatfindingpm:dispatchedpriority:p3

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions