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
IDEs like VS Code can use these comments to display hover informations and signature help, which reduces the need to go to the official documentation website and reduces context switching.
The TanStack Table API is already well documented on the official documentation website, and that documentation could simply be brought over as JSDoc comments.
The downside of this approach is that all documentation would essentially be duplicated, once for the documentation website, then for the JSDoc comments. The comments might also have to be duplicated if the TypeScript type definitions are themselves, duplicated.
It's a very simple feature and I'd gladly contribute it. I just want to discuss it before going ahead with it.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Some libraries use JSDoc comments to document their APIs. (e.g. @types/react, React Router, Redux)
IDEs like VS Code can use these comments to display hover informations and signature help, which reduces the need to go to the official documentation website and reduces context switching.
The TanStack Table API is already well documented on the official documentation website, and that documentation could simply be brought over as JSDoc comments.
The downside of this approach is that all documentation would essentially be duplicated, once for the documentation website, then for the JSDoc comments. The comments might also have to be duplicated if the TypeScript type definitions are themselves, duplicated.
It's a very simple feature and I'd gladly contribute it. I just want to discuss it before going ahead with it.
Cheers! 😁
Beta Was this translation helpful? Give feedback.
All reactions