Skip to content

Docs: Drop JSDoc params the functions no longer take - #34226

Merged
Mugen87 merged 1 commit into
mrdoob:devfrom
darkdi:jsdoc-stale-params
Aug 13, 2026
Merged

Mugen87 merged 1 commit into
mrdoob:devfrom
darkdi:jsdoc-stale-params

Conversation

@darkdi

@darkdi darkdi commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Was reading VarIntent and the block above it documents a name parameter, but the arrow function only takes node. The one directly above it, Const, takes both, so the block looks like it got copied down and never trimmed. Went through the rest of src after that and three more turned up the same way. Switch carries a method param from Else sitting above it, setupDiffuseColor documents geometry when it actually destructures that out of the builder it is given, and the BindGroup constructor still documents an index it does not take.

Left alone the TSL factories, where the block sits over something like nodeProxyIntent( MathNode, MathNode.ALL ) and the documented names belong to the function being produced rather than to the call written underneath, and also the places where a parameter is commented out in the signature, getPropertyName( node/*, shaderStage*/ ) and friends, since that reads as deliberate rather than stale.

@github-actions

Copy link
Copy Markdown

📦 Bundle size

Full ESM build, minified and gzipped.

Before After Diff
WebGL 366.33
86.87
366.33
86.87
+0 B
+0 B
WebGPU 696.95
192.4
696.95
192.4
+0 B
+0 B
WebGPU Nodes 694.94
192.09
694.94
192.09
+0 B
+0 B

🌳 Bundle size after tree-shaking

Minimal build including a renderer, camera, empty scene, and dependencies.

Before After Diff
WebGL 509.71
123.83
509.71
123.83
+0 B
+0 B
WebGPU 771.57
207.28
771.57
207.28
+0 B
+0 B
WebGPU Nodes 720.53
194.62
720.53
194.62
+0 B
+0 B

@Mugen87 Mugen87 added this to the r186 milestone Aug 13, 2026
@Mugen87
Mugen87 merged commit 5c3b1df into mrdoob:dev Aug 13, 2026
10 checks passed
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.

2 participants