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

Small JSDoc normalization/fixes #6369

Merged
merged 2 commits into from
May 15, 2024

Conversation

kungfooman
Copy link
Collaborator

@kungfooman kungfooman commented May 15, 2024

Problem with TS style types is:

  1. Can't add inline-documentation to the properties.
  2. Quickly escalate line length (was > 100).

So I normalized that into JSDoc style and added some description what it is about. targets.once is also optional, which the TS type didn't point out, leading to type mismatch.

I confirm I have read the contributing guidelines and signed the Contributor License Agreement.

Copy link

vercel bot commented May 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
engine ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 15, 2024 9:33am

Copy link
Contributor

@willeastcott willeastcott left a comment

Choose a reason for hiding this comment

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

Thanks! 🙏

@willeastcott willeastcott merged commit d16e78f into playcanvas:main May 15, 2024
9 checks passed
@kungfooman kungfooman deleted the jsdoc-normalization-fix branch May 15, 2024 09:39
slimbuck pushed a commit to slimbuck/engine that referenced this pull request May 20, 2024
* Fix/normalize examples/utils/plugins/rollup-copy-static.mjs, targets#once is optional

* Mark `y`/`z` as optional when `x` can be the entire `Vec3`
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.

3 participants