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

tsdoc-param-tag-with-invalid-name is incorrectly reported for certain identifiers (issue #148) #148

Closed
iclanton opened this issue Mar 12, 2019 · 2 comments
Labels
bug Something isn't working as intended

Comments

@iclanton
Copy link
Member

A @param tag for a parameter called type (i.e. - @param type - ...) gives this error:

(tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier "type" must be quoted because it is a TSDoc system selector name

But changing the tag to @param "type" - ..., causes this error:

(tsdoc-param-tag-with-invalid-name) The @param block should be followed by a parameter name

This makes it impossible to document a parameter called type.

@octogonz octogonz changed the title tsdoc-param-tag-with-invalid-name and tsdoc-param-tag-with-invalid-name conflict with each other tsdoc-param-tag-with-invalid-name is incorrectly reported for certain identifiers (issue #148) Mar 12, 2019
@octogonz octogonz added the bug Something isn't working as intended label Mar 12, 2019
@octogonz
Copy link
Collaborator

Fixed by #149

@dsogari
Copy link

dsogari commented Dec 22, 2023

The same thing still happens for @link tags. For example, {@link type} gives this error:

tsdoc-reference-unquoted-identifier: The identifier "type" must be quoted because it is a TSDoc system selector name  tsdoc/syntax

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working as intended
Projects
None yet
Development

No branches or pull requests

3 participants