Closed Masstronaut closed 1 year ago
This is unrelated to this addon, but actually a problem in Storybook's doc parsing not supporting TypeScript. Check out https://github.com/storybookjs/storybook/issues/15891 which describes why and a potential workaround.
Closing in favor of https://github.com/storybookjs/storybook/issues/15891
Describe the bug
Svelte component props documented with the officially recommended method - JSDoc comments - don't have their description added to the autodocs. Example:
Elsewhere in VSCode - including in
*.stories.svelte
files - this comment shows up as a tooltip for thevariant
prop of theAlert
component. You can see in this screenshot that hovering overvariant
on anAlert
component causes the tooltip and description to appear:However, in my autodocs for the
Alert
component, the description for thevariant
prop is not present:Steps to reproduce the behavior
Expected behavior
Prop comments should be included in the appropriate place in autodocs
Screenshots and/or logs
See screenshots above
Environment
Additional context
Add any other context about the problem here.