`@inheritdoc` does not work in Visual Studio Code (only `@inheritDoc` does)
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
VSCode intellisense does not seem to respect all lower-case @inheritdoc in tsdoc comments. It seems to only respect the camelCase @inheritDoc. Other tools (e.g. API-Extractor) do not seem to have any issue with the all lower-case form.
Note that the eslint plugin also does not seem to care about casing. If the all lower-case form is not considered valid per spec, then it would be nice if the eslint plugin would catch the incorrect casing.
That the linter and the VSCode behavior seem to disagree on casing requirements makes it very easy to introduce comments that are incompatible with VSCode intellisense.
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
Start by comparing VS Code IntelliSense handling of @inheritdoc and @inheritDoc, then review the TSDoc specification and the eslint plugin's casing behavior. Done means the casing requirement is consistent across VS Code, the specification, and linting, or the expected behavior is clearly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript, vscode
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100