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 option for generating private documentation #10261

Merged
merged 1 commit into from
Apr 6, 2022
Merged

Added option for generating private documentation #10261

merged 1 commit into from
Apr 6, 2022

Conversation

IanLilleyT
Copy link
Contributor

How to use:

npm run generateDocumentation -- --private

This will generate documentation for all @private elements. It's intended for local development purposes only.

This PR also adds the --pedantic flag which treats warnings as errors. See https://jsdoc.app/about-commandline.html. This would have caught #10208. Are there any downsides to adding this flag?

@cesium-concierge
Copy link

Thanks for the pull request @IanLilleyT!

  • ✔️ Signed CLA found.
  • CHANGES.md was not updated.
    • If this change updates the public API in any way, please add a bullet point to CHANGES.md.
  • ❔ Unit tests were not updated.
    • Make sure you've updated tests to reflect your changes, added tests for any new code, and ran the code coverage tool.

Reviewers, don't forget to make sure that:

  • Cesium Viewer works.
  • Works in 2D/CV.

@ggetz
Copy link
Contributor

ggetz commented Apr 4, 2022

Hi @IanLilleyT, what's the motivation behind generating docs for the private symbols? Just for verification purposes?

@IanLilleyT
Copy link
Contributor Author

Yep, just for verification purposes. Trying to make sure I'm being careful

@ggetz
Copy link
Contributor

ggetz commented Apr 6, 2022

Cool, works for me. Thanks @IanLilleyT !

@ggetz ggetz merged commit b3f0fad into main Apr 6, 2022
@ggetz ggetz deleted the privateDoc branch April 6, 2022 16:18
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