You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
After: 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.
The text was updated successfully, but these errors were encountered:
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:
After:
Here I've just copy pasted the jsdoc comment from src for
fit
and pasted it into theViewport.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.
The text was updated successfully, but these errors were encountered: