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

Docs: fix types #30677

Merged
merged 1 commit into from
Mar 7, 2025
Merged

Docs: fix types #30677

merged 1 commit into from
Mar 7, 2025

Conversation

s-rigaud
Copy link
Contributor

@s-rigaud s-rigaud commented Mar 7, 2025

Description

Fix some types in the doc

Copy link

github-actions bot commented Mar 7, 2025

📦 Bundle size

Full ESM build, minified and gzipped.

Before After Diff
WebGL 336.02
78.26
336.02
78.26
+0 B
+0 B
WebGPU 523.84
145.45
523.84
145.45
+0 B
+0 B
WebGPU Nodes 523.31
145.34
523.31
145.34
+0 B
+0 B

🌳 Bundle size after tree-shaking

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

Before After Diff
WebGL 465.06
112.14
465.06
112.14
+0 B
+0 B
WebGPU 594.24
161.05
594.24
161.05
+0 B
+0 B
WebGPU Nodes 549.37
150.49
549.37
150.49
+0 B
+0 B

@@ -25,7 +25,7 @@ class LatheGeometry extends BufferGeometry {
/**
* Constructs a new lathe geometry.
*
* @param {Array<Vector2>} [points] - An array of points in 2D space. The x-coordinate of each point
* @param {Array<Vector2|Vector3>} [points] - An array of points in 2D space. The x-coordinate of each point
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why should we allow here Vector3?

Copy link
Contributor Author

@s-rigaud s-rigaud Mar 7, 2025

Choose a reason for hiding this comment

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

  1. CapsuleGeometry extends LatheGeometry
  2. CapsuleGeometry uses Path().getPoints( capSegments ) for points attribute
  3. Path extends CurvePath
  4. CurvePath.getPoints depends on CurvePath.getPoint
  5. CurvePath.getPoint returns a Vector2 or a Vector3

@Mugen87 Mugen87 added this to the r175 milestone Mar 7, 2025
@Mugen87 Mugen87 merged commit ddfa74b into mrdoob:dev Mar 7, 2025
12 checks passed
@Mugen87
Copy link
Collaborator

Mugen87 commented Mar 8, 2025

@s-rigaud BTW: Thank you for all your contributions lately! Your PRs are an important QA for the project's JSDoc and also improve the overall code quality 🙌.

@s-rigaud
Copy link
Contributor Author

s-rigaud commented Mar 8, 2025

Thanks a lot, I'm happy to help. It's nothing compare to your contributions over the years but just a few PRs might help the project QA 😁

@s-rigaud s-rigaud deleted the fix-multiple-doc-typos branch March 12, 2025 14:02
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