Skip to content

[finding] ObjectForm.tsx opens one doc comment with a doubled /** #4661

Description

@yinlianghui

Tripped over while renaming ObjectFormProps for #4650 (PR #4660). Recorded, not claimed
and not swept in#4650's surface is the rename, and this is unrelated to it.

The line

packages/plugin-form/src/ObjectForm.tsx, the doc comment above foldFormButtons, opens with
two /** lines in a row. On origin/main @ a99233fff that is line 67; anchor by the
foldFormButtons declaration rather than by line number, since #4660 shifts it.

/**
/**
 * Fold the structured, spec-aligned `buttons`/`defaults` surface
 * (`@objectstack/spec` FormViewSchema; framework#1894 / #2998) down onto the
 ...
 */
function foldFormButtons(...)

Why it is observation-class, and may well be WONTFIX

Nothing is broken and nothing renders wrong. A block comment opened by the first /** runs to
the first */, so the second /** is just characters inside it; the JSDoc still attaches to
foldFormButtons, and editors show the intended text. tsc, ESLint and Prettier all pass over
it today — it survived precisely because no tool has an opinion about it.

The only cost is to a reader who meets a malformed-looking comment opener and stops to work out
whether something was lost in a bad merge. Filed plainly rather than judged: it is a one-line
deletion if anyone agrees it is worth a commit, and a fair close if not.

Verified

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions