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

Add documentation for 'PreviewHandler' #8625

Merged

Conversation

sdirix
Copy link
Member

@sdirix sdirix commented Oct 13, 2020

  • Document 'PreviewHandler'
  • Add extension guide to README.md

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

Copy link
Member

@vince-fugnitto vince-fugnitto left a 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 👍.

packages/preview/README.md Outdated Show resolved Hide resolved
packages/preview/README.md Outdated Show resolved Hide resolved
packages/preview/README.md Outdated Show resolved Hide resolved
packages/preview/src/browser/preview-handler.ts Outdated Show resolved Hide resolved
packages/preview/src/browser/preview-handler.ts Outdated Show resolved Hide resolved
packages/preview/src/browser/preview-handler.ts Outdated Show resolved Hide resolved
packages/preview/src/browser/preview-handler.ts Outdated Show resolved Hide resolved
packages/preview/src/browser/preview-handler.ts Outdated Show resolved Hide resolved
packages/preview/src/browser/preview-handler.ts Outdated Show resolved Hide resolved
packages/preview/src/browser/preview-handler.ts Outdated Show resolved Hide resolved
@vince-fugnitto vince-fugnitto added documentation issues related to documentation preview issues related to the preview labels Oct 13, 2020
* Document preview-handler.ts
* Add custom preview guide to README.md

Signed-off-by: Stefan Dirix <sdirix@eclipsesource.com>
Contributed on behalf of STMicroelectronics
@sdirix sdirix force-pushed the preview-documentation branch from e477abc to 96df97e Compare October 14, 2020 15:58
@sdirix
Copy link
Member Author

sdirix commented Oct 14, 2020

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

I agree, a style guide would be very beneficial. Especially when it's encoded in ESLint.

Copy link
Member

@vince-fugnitto vince-fugnitto left a 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! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to documentation preview issues related to the preview
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for 'PreviewHandler'
2 participants