Skip to content
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.

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

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

Open
nicolo-ribaudo opened this issue Feb 2, 2025 · 0 comments
Open
Labels
docs gen Related to the documentation generation upstream Issue is in upstream project

Comments

@nicolo-ribaudo
Copy link
Contributor

nicolo-ribaudo commented Feb 2, 2025

@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

@github-project-automation github-project-automation bot moved this to Needs Triage in JSR Feb 2, 2025
@crowlKats crowlKats moved this from Needs Triage to Ready in JSR Feb 3, 2025
@crowlKats crowlKats added docs gen Related to the documentation generation upstream Issue is in upstream project labels Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs gen Related to the documentation generation upstream Issue is in upstream project
Projects
Status: Ready
Development

No branches or pull requests

2 participants