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: replaced @link to @see in jsdoc #477

Merged
merged 3 commits into from Apr 29, 2021
Merged

docs: replaced @link to @see in jsdoc #477

merged 3 commits into from Apr 29, 2021

Conversation

cawa-93
Copy link
Member

@cawa-93 cawa-93 commented Apr 28, 2021

@link is inline directive. Therefore, using it as

/**
 * @link https://...
 */

is actually a wrong syntax. As a result, some editors do not handle links correctly:

зображення
Note that the link is https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver|MutationObserver.

Also, in rendered mode @link are not parsed at all,
зображення

Because the @link is used as a block directive, I replaced it with the @see directive, and changed the syntax for anchors in some places. Now:

зображення
зображення

Alternatively, you could use the link directive, but in an inline mode:

/**
 * {@link https://...}
 */

@cawa-93 cawa-93 marked this pull request as draft April 28, 2021 08:48
@cawa-93 cawa-93 marked this pull request as ready for review April 28, 2021 08:51
@antfu
Copy link
Member

antfu commented Apr 29, 2021

Thanks a lot!

@antfu antfu changed the title Replaced @link to @see in comments docs: replaced @link to @see in jsdoc Apr 29, 2021
@antfu antfu merged commit 384845a into vueuse:main Apr 29, 2021
@cawa-93 cawa-93 deleted the see-link branch April 29, 2021 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants