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.

Sign up for GitHub

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

Jump to bottom

Use twoslash in jsdoc examples so we can get intellisense in the docs #793

Open

moldy530 opened this issue Jun 27, 2024 · 1 comment

Collaborator

moldy530 commented Jun 27, 2024

No description provided.

Collaborator Author

moldy530 commented Jun 27, 2024

we should update the requirement for @example tags to be in the format of: /^```(js|javascript|ts|tsx) twoslash$/gm

This would then mean that all of the generated docs leverage twoslash which enables developers to hover over the types in the SDK reference docs

moldy530 mentioned this issue

Use twoslash to create an eslint rule that validates jsdoc example tags #794

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment