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

No docs for {@link URL | label } #807

Open
nicolo-ribaudo opened this issue Nov 3, 2024 · 0 comments
Open

No docs for {@link URL | label } #807

nicolo-ribaudo opened this issue Nov 3, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@nicolo-ribaudo
Copy link

nicolo-ribaudo commented Nov 3, 2024

It seems like JSR allows creating links using the {@link URL | label } syntax (or with @linkcode). However:

This syntax is very hard to discover, because it's also not the first syntax mentioned on the JSDoc website (https://jsdoc.app/tags-inline-link), which is [label]{@link URL}. At my first attempt I used this syntax and just assumed that Deno/JSR does not support custom labels for links.

@github-project-automation github-project-automation bot moved this to Needs Triage in JSR Nov 3, 2024
@lucacasonato lucacasonato added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Status: Needs Triage
Development

No branches or pull requests

2 participants