Skip to content

Invalid error for a link from valid-types #143

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

Closed
lll000111 opened this issue Jan 7, 2019 · 4 comments · Fixed by #197 · May be fixed by postmanlabs/newman-reporter-remote#108 or postmanlabs/newman-reporter-html#172
Closed

Invalid error for a link from valid-types #143

lll000111 opened this issue Jan 7, 2019 · 4 comments · Fixed by #197 · May be fixed by postmanlabs/newman-reporter-remote#108 or postmanlabs/newman-reporter-html#172

Comments

@lll000111
Copy link

lll000111 commented Jan 7, 2019

Error:

Syntax error in type: @link module:message-bus#on|on            jsdoc/valid-types

The JSDoc:

/**
 ...
 * @see {@link module:message-bus~on|on}
 ...
 */

That link resolves just fine in the jsdoc3 HTML output, i.e. it a) is there and b) it is a valid link. That means there is nothing wrong here.

@gajus
Copy link
Owner

gajus commented Jan 7, 2019

PR is welcome.

@lll000111
Copy link
Author

Sure, always. And so are big reports, and here is one.

@dashaki
Copy link

dashaki commented Jan 7, 2019

@lll000111 I just ran into this issue and a "workaround" is to place the {@link} statement on a new line. Somehow that makes the parser happy :)

@gajus
Copy link
Owner

gajus commented Apr 9, 2019

🎉 This issue has been resolved in version 4.8.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment