`tsdoc-reference-unquoted-identifier` is incorrectly reported for certain identifiers
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
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
Originally posted by @diegosogari in https://github.com/microsoft/tsdoc/issues/148#issuecomment-1867669304
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the diagnostic with the issue's example, {@link type}, then trace how TSDoc link references classify identifiers and system selector names. Confirm the intended behavior for this identifier and related cases, and verify that the erroneous tsdoc-reference-unquoted-identifier report no longer appears without weakening valid quoting diagnostics.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100