Skip to content

Poor lint output for invalid @typedef #372

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

Open
jfirebaugh opened this issue Mar 13, 2016 · 2 comments
Open

Poor lint output for invalid @typedef #372

jfirebaugh opened this issue Mar 13, 2016 · 2 comments

Comments

@jfirebaugh
Copy link
Member

/**
 * @typedef Comment
 */

Actual error message from documentation lint:

/path/filename.js
        1:1  warning  Missing or invalid tag type
        1:1  warning  could not determine @name for hierarchy

The line number is wrong and there's no indication that the issue is with the @typedef. If lint wants to complain that @typedef should specify a type, a good error message would be:

/path/filename.js
        2:1  warning  @typedef without a type. Expected `@typedef <type> <namepath>`.

However, according to JSDoc docs, <type> is actually optional. So the fact that lint is even complaining might be a bug in documentationjs.

@tmcw
Copy link
Member

tmcw commented Nov 18, 2016

@jfirebaugh should this be merged with #574 which also complains about the incorrect line number and sketchy error message?

@jfirebaugh
Copy link
Member Author

#574 is about @param so I think they are separate issues.

rhendric pushed a commit to rhendric/documentation that referenced this issue Sep 15, 2022
* Describe valid escape sequences in string literals

* Describe differences from Haskell regarding strings and chars
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

No branches or pull requests

2 participants