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

[Docs] Suggestion: keep Jsdocs in npm package? #479

Open
metruzanca opened this issue Feb 19, 2024 · 0 comments
Open

[Docs] Suggestion: keep Jsdocs in npm package? #479

metruzanca opened this issue Feb 19, 2024 · 0 comments

Comments

@metruzanca
Copy link

Seems you've got very good Jsdoc comments in this package, but they're only being used to generate the web docs and stripped out from the package. Stripping them out for cdn (.min) files makes sense, but for npm packages it would be very nice to maintain those inline doc comments.

Before:
Code_-_Insiders_ZdpRcoQwaq

After:
Code_-_Insiders_IEH4pFoXRa
Here I've just copy pasted the jsdoc comment from src for fit and pasted it into the Viewport.d.ts file.

Overall, I think this would be a huge UX improvement for consumers of the library. Sure, docs will still be used/needed for more long form writing, but just to make sure you've got the right method, this would be great help.

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

No branches or pull requests

1 participant