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

Correcting sort values in documentation and examples #207

Closed
wants to merge 1 commit into from

Conversation

msturdikova
Copy link
Contributor

No description provided.

@texodus
Copy link
Member

texodus commented Aug 26, 2018

Thanks for the PR!

You are correct that the documentation for the sort attribute is in error, and the fix is appreciated.
However, the patch itself modifies the wrong files - the modified files e.g. perspsective-viewer/README.md are auto-generated from the JSDoc inlined into the source itself, as per the note on the first line of each of these files:

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

To update the documentation for a module, you must update the JSDoc in the source itself, then run lerna run docs from project root (or npm run docs from the package in question). Otherwise - these changes will be lost on the next release or docs update.

@msturdikova
Copy link
Contributor Author

Oh will do! Thanks for the steps!

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.

None yet

2 participants