Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jsdoc: More fixes #30557

Merged
merged 1 commit into from
Feb 18, 2025
Merged

Jsdoc: More fixes #30557

merged 1 commit into from
Feb 18, 2025

Conversation

s-rigaud
Copy link
Contributor

Description

Fix more types in the doc.

Copy link

github-actions bot commented Feb 18, 2025

📦 Bundle size

Full ESM build, minified and gzipped.

Before After Diff
WebGL 336.51
78.38
336.51
78.38
+0 B
+0 B
WebGPU 519.2
144.16
519.21
144.16
+7 B
-1 B
WebGPU Nodes 518.67
144.05
518.67
144.05
+7 B
-2 B

🌳 Bundle size after tree-shaking

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

Before After Diff
WebGL 465.51
112.23
465.51
112.23
+0 B
+0 B
WebGPU 591.03
160.12
591.03
160.12
+0 B
+0 B
WebGPU Nodes 546.34
149.59
546.34
149.59
+0 B
+0 B

@@ -654,7 +654,18 @@ class PassNode extends TempNode {

}

/**
* @static
* @type {'color'}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you please use string here?

Copy link
Contributor Author

@s-rigaud s-rigaud Feb 18, 2025

Choose a reason for hiding this comment

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

Not really, the type system does not seem to take static as a const and only use the string type so it displays an error

image
image

Copy link
Collaborator

Choose a reason for hiding this comment

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

Okay, I understand the issue now. It's related to how scope of PassNode is defined. The change is indeed correct.


/**
* @static
* @type {'depth'}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here.

@Mugen87 Mugen87 merged commit 4c20612 into mrdoob:dev Feb 18, 2025
12 checks passed
@Mugen87 Mugen87 added this to the r174 milestone Feb 18, 2025
@s-rigaud s-rigaud deleted the jsdoc-more-fixes branch February 26, 2025 13:39
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