Add @template tag to no-undefined-types docs #291
Conversation
README.md
Outdated
| @@ -678,7 +678,7 @@ function quux () {} | |||
| function quux2 () { | |||
|
|
|||
| } | |||
| // Settings: {"jsdoc":{"matchingFileName":"/Users/brett/eslint-plugin-jsdoc/test/rules/data/test.js"}} | |||
There was a problem hiding this comment.
Oh, looks like a local path snuck in here. Not sure what I can do about it in this PR, this has to be updated in upstream.
There was a problem hiding this comment.
Actually, I did the nasty thing and dropped out the commit with a force push. This way it's not in the diff at least and won't get in the way once the path reference is removed in upstream.
There was a problem hiding this comment.
Yeah, ESLint 6 requires absolute paths, and it seems the documentation generator resolves the path to the final result. For now, I can just rebase your PR and regenerate the docs on my machine to avoid your own path getting in there.
There was a problem hiding this comment.
Your force push solution is fine. Could you add this in parentheses though after @template: " (for Closure)"?
There was a problem hiding this comment.
or " (for Closure/TypeScript)"... It is not a standard jsdoc tag, so I think that should be called out for those who might otherwise try to search for the tag on https://jsdoc.app and not find it...
There was a problem hiding this comment.
Nevermind, I handled it (and changed the commit message to "docs:"). Thanks for the docs!
|
Sorry for the disconnected rebase, but this is now included in |
Essentially a follow up to #283, I noticed I forgot to update documentation.