Skip to content

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

Closed

Description

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.

Activity

  1. 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)[/+] on Mar 12, 2019
  2. octogonz commented on Mar 12, 2019

    @octogonz
    Collaborator

    Fixed by #149

  3. dsogari commented on Dec 22, 2023

    @dsogari

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working as intended

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions