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

Added experimental jsdoc tag #6010

Merged
merged 2 commits into from
Nov 30, 2017
Merged

Added experimental jsdoc tag #6010

merged 2 commits into from
Nov 30, 2017

Conversation

ggetz
Copy link
Contributor

@ggetz ggetz commented Nov 29, 2017

As mentioned in #4665, @pjcozzi

Adding the tag plus a description like so:

*
* @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
*

Results in:

image

@cesium-concierge
Copy link

Signed CLA is on file.

@ggetz, thanks for the pull request! Maintainers, we have a signed CLA from @ggetz, so you can review this at any time.

⚠️ I noticed that CHANGES.md has not been updated. If this change updates the public API in any way, fixes a bug, or makes any non-trivial update, please add a bullet point to CHANGES.md and comment on this pull request so we know it was updated. For more info, see the Pull Request Guidelines.


I am a bot who helps you make Cesium awesome! Contributions to my configuration are welcome.

🌍 🌎 🌏

@pjcozzi
Copy link
Contributor

pjcozzi commented Nov 29, 2017

LGTM.

Please update CHANGES.md and https://github.com/AnalyticalGraphicsInc/cesium/tree/master/Documentation/Contributors/CodingGuide#deprecation-and-breaking-changes to explain that a very small subset of APIs are experimental to, for example, allow for implementing draft formats and may have breaking changes without deprecation in future Cesium releases.

Anyone else want to look at this?

@ggetz
Copy link
Contributor Author

ggetz commented Nov 29, 2017

Updated.

@pjcozzi
Copy link
Contributor

pjcozzi commented Nov 30, 2017

Thanks!

@pjcozzi pjcozzi merged commit 4692513 into CesiumGS:master Nov 30, 2017
@pjcozzi pjcozzi deleted the experimental-jsdoc branch November 30, 2017 13:51
@pjcozzi pjcozzi mentioned this pull request Nov 30, 2017
2 tasks
This pull request was closed.
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