docs: JSDoc whitespace cleanup#8616
Merged
Merged
Conversation
Made-with: Cursor
Contributor
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Pure JSDoc / comment whitespace cleanup found by a sweep of the engine with
rg --pcre2. 16 fixes across 14 files. No API signatures, runtime behavior, or generated.d.tstypes are affected.Categories
Trailing whitespace on JSDoc/comment lines (3)
src/scene/shader-lib/wgsl/chunks/lit/frag/lighting/lightDeclaration.js— trailing spaces after*/src/scene/shader-lib/glsl/chunks/lit/frag/lighting/shadowPCSS.js— 2 trailing spaces at ends of comment linesDouble space after sentence-ending period → single space (8)
src/scene/mesh.js—render. Can be:src/scene/materials/standard-material.js—blending. Can be:src/framework/script/script-attributes.js—value. Can be:src/framework/components/element/component.js—right. Only works forsrc/framework/handlers/script.js—dynamically. Two types ofsrc/platform/graphics/texture.js(x2) —type. Can be:andtexture. Normally, thissrc/scene/shader-lib/shader-chunk-map.js—code. As this classStray double space between adjacent words → single space (3)
src/scene/mesh-instance.js—by the camera frustumsrc/extras/render-passes/frame-pass-camera-frame.js—integrated post-processingsrc/framework/components/rigid-body/system.js—contact normal directionStray double space before
@tag → single space (2)src/scene/frame-graph.js—* @type {...}src/scene/gsplat/gsplat-resource-base.js—* @ignoreWhat was deliberately excluded
@exampleblocks across the codebase frequently use multiple spaces to align trailing// commentannotations (e.g.src/core/math/vec3.js,src/core/path.js,src/platform/net/http.js, etc.). Those are intentional and left untouched. The markdown table insrc/framework/handlers/container.jsis similarly deliberate and not modified.Test plan
npx eslinton all 14 touched files → 0 errors..d.tstypes are affected.