-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Add documentation for 'PreviewHandler' #8625
Add documentation for 'PreviewHandler' #8625
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sdirix thank you for the contribution, and your efforts in improving the documentation.
I have a few comments, namely about the wording, and consistency between doc updates.
Please also take the time to fix the build errors caused by extra trailing spaces.
With all these welcomed documentation updates, I'm wondering if we should enforce a certain doc style with the use of eslint and adopting a certain style guide. It may be worthwhile to update the repo to enforce the style, perhaps as warnings
initially but it did get me thinking 👍.
* Document preview-handler.ts * Add custom preview guide to README.md Signed-off-by: Stefan Dirix <sdirix@eclipsesource.com> Contributed on behalf of STMicroelectronics
e477abc
to
96df97e
Compare
I agree, a style guide would be very beneficial. Especially when it's encoded in ESLint. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for contributing the documentation updates! 👍
Signed-off-by: Stefan Dirix sdirix@eclipsesource.com
Contributed on behalf of STMicroelectronics
Closes #8624
What it does
Add API documentation and extension guide to the
preview
package.How to test
No need to specifically test as only documentation was changed
Review checklist
Reminder for reviewers