Skip to content

fix(scripts): remove inline {@link} from camera-frame LUT attribute description#8849

Merged
mvaligursky merged 1 commit into
mainfrom
mv-fix-camera-frame-lut-jsdoc
Jun 5, 2026
Merged

fix(scripts): remove inline {@link} from camera-frame LUT attribute description#8849
mvaligursky merged 1 commit into
mainfrom
mv-fix-camera-frame-lut-jsdoc

Conversation

@mvaligursky

Copy link
Copy Markdown
Contributor

The CameraFrame script fails to parse in the Editor after the dual-LUT change (#8749). The texture2 attribute's description contained an inline JSDoc {@link ColorLUT#blend} tag.

When a JSDoc summary contains {@link}, TypeScript represents the comment as a NodeArray of comment nodes rather than a plain string. The attribute parser stores this verbatim as the attribute's description, and because those nodes carry circular parent references, serializing the parsed schema throws Converting circular structure to JSON — surfacing as an Editor parse error even though the program itself parses without error.

Changes:

  • Replace the inline {@link ColorLUT#blend} reference in the texture2 description with plain prose, so the description stays a string and the schema serializes cleanly.

…escription

The CameraFrame script fails to parse in the Editor after the dual-LUT
change (#8749). The texture2 attribute description contained an inline
JSDoc {@link ColorLUT#blend} tag.

When a JSDoc summary contains {@link}, TypeScript represents the comment
as a NodeArray of comment nodes rather than a plain string. The attribute
parser stores this verbatim as the attribute description, and because
those nodes carry circular parent references, serializing the parsed
schema throws 'Converting circular structure to JSON' - surfacing as an
Editor parse error even though the program itself parses without error.

Replace the inline link with plain prose so the description stays a
string and the schema serializes cleanly.
@mvaligursky mvaligursky self-assigned this Jun 5, 2026
@mvaligursky mvaligursky merged commit 0109a58 into main Jun 5, 2026
8 checks passed
@mvaligursky mvaligursky deleted the mv-fix-camera-frame-lut-jsdoc branch June 5, 2026 12:06
mvaligursky added a commit that referenced this pull request Jun 5, 2026
…escription (#8849)

The CameraFrame script fails to parse in the Editor after the dual-LUT
change (#8749). The texture2 attribute description contained an inline
JSDoc {@link ColorLUT#blend} tag.

When a JSDoc summary contains {@link}, TypeScript represents the comment
as a NodeArray of comment nodes rather than a plain string. The attribute
parser stores this verbatim as the attribute description, and because
those nodes carry circular parent references, serializing the parsed
schema throws 'Converting circular structure to JSON' - surfacing as an
Editor parse error even though the program itself parses without error.

Replace the inline link with plain prose so the description stays a
string and the schema serializes cleanly.

Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
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