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
Svelte component props documented with the officially recommended method - JSDoc comments - don't have their description added to the autodocs. Example:
<scriptlang="ts">
// Alert.svelte/** * The variant sets the styling of the alert. * Use `Alert` variants to provide additional context to the user about the alert information. */exportlet variant:AlertVariant|undefined=undefined;
</script>
Elsewhere in VSCode - including in *.stories.svelte files - this comment shows up as a tooltip for the variant prop of the Alert component. You can see in this screenshot that hovering over variant on an Alert component causes the tooltip and description to appear:
However, in my autodocs for the Alert component, the description for the variant prop is not present:
Steps to reproduce the behavior
Create a svelte component with a prop that has a JSDoc comment describing it
This is unrelated to this addon, but actually a problem in Storybook's doc parsing not supporting TypeScript. Check out storybookjs/storybook#15891 which describes why and a potential workaround.
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.
The text was updated successfully, but these errors were encountered: