Skip to content

[Bug] JSDoc description disappears with lang="ts" #175

Open
@rChaoz

Description

@rChaoz

According to the documentation, to set the description of a component you should use a JSDoc comment above the meta variable or above the component. The first variant does not work and the second one doesn't make sense (what is "above" a Svelte component)?

The only variant remaining is to set the string manually in meta like so:

export const meta = {
    ...other,
    parameters: {
        docs: {
            description: {
                component: "Description here"
            }
        }
    }
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    legacyRelated to the legacy version(s)

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions