Skip to content

docs: JSDoc whitespace cleanup#8616

Merged
willeastcott merged 1 commit into
mainfrom
docs/jsdoc-whitespace
Apr 19, 2026
Merged

docs: JSDoc whitespace cleanup#8616
willeastcott merged 1 commit into
mainfrom
docs/jsdoc-whitespace

Conversation

@willeastcott

Copy link
Copy Markdown
Contributor

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.ts types 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 lines

Double space after sentence-ending period → single space (8)

  • src/scene/mesh.jsrender. Can be:
  • src/scene/materials/standard-material.jsblending. Can be:
  • src/framework/script/script-attributes.jsvalue. Can be:
  • src/framework/components/element/component.jsright. Only works for
  • src/framework/handlers/script.jsdynamically. Two types of
  • src/platform/graphics/texture.js (x2) — type. Can be: and texture. Normally, this
  • src/scene/shader-lib/shader-chunk-map.jscode. As this class

Stray double space between adjacent words → single space (3)

  • src/scene/mesh-instance.jsby the camera frustum
  • src/extras/render-passes/frame-pass-camera-frame.jsintegrated post-processing
  • src/framework/components/rigid-body/system.jscontact normal direction

Stray double space before @ tag → single space (2)

  • src/scene/frame-graph.js * @type {...}
  • src/scene/gsplat/gsplat-resource-base.js * @ignore

What was deliberately excluded

@example blocks across the codebase frequently use multiple spaces to align trailing // comment annotations (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 in src/framework/handlers/container.js is similarly deliberate and not modified.

Test plan

  • npx eslint on all 14 touched files → 0 errors.
  • Documentation-only. No runtime behaviour or generated .d.ts types are affected.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@willeastcott willeastcott merged commit 447d451 into main Apr 19, 2026
16 checks passed
@willeastcott willeastcott deleted the docs/jsdoc-whitespace branch April 19, 2026 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants