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

Using primitive type instead of built-in object in jsdoc #11079

Closed
wewindy opened this issue Feb 9, 2023 · 2 comments
Closed

Using primitive type instead of built-in object in jsdoc #11079

wewindy opened this issue Feb 9, 2023 · 2 comments
Labels
category - typescript good first issue An opportunity for first time contributors

Comments

@wewindy
Copy link
Contributor

wewindy commented Feb 9, 2023

CesiumJS using jsdoc to get better experience, such as API documents.

Currently, CesiumJS uses JavaScript built-in object types in jsdoc, such as String, Number, etc. But now whether it is jsdoc or the front-end popular practice, primitive types are widely used, I mean use string instead of String, and so on.

eg. :

/**
 * Asynchronously transitions the scene to Columbus View.
- * @param {Number} [duration=2.0] The amount of time, in seconds, for transition animations to complete.
+ * @param {number} [duration=2.0] The amount of time, in seconds, for transition animations to complete.
 */
Scene.prototype.morphToColumbusView = function (duration) {
  // ..
}

So is it possible to do a replacement, or what is the reason for not replacing it so far? Thanks.

@ggetz
Copy link
Contributor

ggetz commented Feb 9, 2023

Hi @onsummer, yes its known that the primitive types are inconsistently cased throughout the docs. it should be possible to do a replacement for the jsdoc types, it just hasn't been done up until this point.

We'd be happy to accept contributions for this!

@ggetz ggetz added category - typescript good first issue An opportunity for first time contributors labels Feb 9, 2023
@wewindy
Copy link
Contributor Author

wewindy commented Feb 10, 2023

@ggetz OK, I will do this in #11080

@wewindy wewindy closed this as completed Feb 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category - typescript good first issue An opportunity for first time contributors
Projects
None yet
Development

No branches or pull requests

2 participants