Skip to content

Docs generator considers the hyphen in @param as a bullet point #914

Open
@nicolo-ribaudo

Description

@nicolo-ribaudo
@param foo - The foo

The JSR website will render the description as a bullet list containing "• The foo", rather than just as "The foo".

Note that the - in JSDoc is optional, but even on the JSDoc website itself it's much more common to have it than not (https://jsdoc.app/tags-param)

Real example: https://jsr.io/@babel-test-6ae45912/[email protected]/doc/~/default

Metadata

Metadata

Assignees

No one assigned

    Labels

    docs genRelated to the documentation generationupstreamIssue is in upstream project

    Type

    Projects

    Status

    Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions