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

Debt: add JSDocs to web components #3634

Open
d13 opened this issue Oct 1, 2024 · 0 comments
Open

Debt: add JSDocs to web components #3634

d13 opened this issue Oct 1, 2024 · 0 comments
Labels
debt Technical debt

Comments

@d13
Copy link
Member

d13 commented Oct 1, 2024

Some web components have a lot of functionality and it takes time to read through the code to know what is available, especially things like Slots and CSS Parts. Adding JSDoc for those will avoid needing to read through the code.

JSDoc formatting for web components: https://custom-elements-manifest.open-wc.org/analyzer/getting-started/#documenting-your-components

@d13 d13 added the debt Technical debt label Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
debt Technical debt
Projects
None yet
Development

No branches or pull requests

1 participant