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

Cryptic "Missing or invalid tag name" lint #574

Open
jfirebaugh opened this issue Oct 21, 2016 · 1 comment
Open

Cryptic "Missing or invalid tag name" lint #574

jfirebaugh opened this issue Oct 21, 2016 · 1 comment
Labels

Comments

@jfirebaugh
Copy link
Member

Test case:

/**
 * Description goes here
 *
 * @param {Array<StructMember>}
 */

Lint output:

  155:1  warning  Missing or invalid tag name

Issues:

  • The line number refers to the start of the comment. It should refer to the @param line.
  • The message is wishy washy. Is the name missing, or is it invalid? Figure it out and tell me.
  • The message is vague. It should say something like The @param tag requires a parameter name.
  • If the type is simpler, like {number}, the lint does not trigger. I can't see why it shouldn't.
  • Bonus points: lint could suggest a name based on the code that follows. "Did you mean members?"
@tmcw tmcw added the upstream label Nov 18, 2016
@tmcw
Copy link
Member

tmcw commented Nov 18, 2016

This error message and its trigger is upstream in doctrine. Keeping this open as a tracking ticket but all actions are in doctrine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants