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

check-tag-names documentation has identical examples marked as correct and incorrect #75

Closed
roryokane opened this issue May 22, 2018 · 0 comments

Comments

@roryokane
Copy link

The current version of check-tag-names documentation in the README: https://github.com/gajus/eslint-plugin-jsdoc/blob/83ff68f6beeb9636424af570a4829c3d4a61a78d/README.md#eslint-plugin-jsdoc-rules-check-tag-names

Some examples are duplicated in the "considered problems" and "not considered problems" sections:

The following patterns are considered problems:

// ...
/**
 * @bar foo
 */
function quux (foo) {

}
// Message: Invalid JSDoc tag name "bar".

/**
 * @baz @bar foo
 */
function quux (foo) {

}
// Message: Invalid JSDoc tag name "baz".
// ...

The following patterns are not considered problems:

// ...
/**
 * @bar foo
 */
function quux (foo) {

}

/**
 * @baz @bar foo
 */
function quux (foo) {

}
// ...

This can't be right. Either those are errors or they aren't. The examples in the wrong section should be deleted.

The example after the duplicates in the "considered problems" section is not repeated, but it is similar to the repeated ones. You should double-check that it is in the right section too:

/**
 * @bar
 * @baz
 */
function quux (foo) {

}
// Message: Invalid JSDoc tag name "baz".
@gajus gajus closed this as completed in 59673c4 May 22, 2018
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

1 participant