JSDoc/TSDoc `@inherit[dD]oc` mismatch
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Seems that TSDoc conflicts with the JSDoc use of @inheritdoc since TSDoc capitalizes the "d" as @inheritDoc.
Is this intentional, if so why? Can both be accepted (given it's too late to go back)?
related VSCode issue: #301
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
No repository file or test is identified in the issue. Start by comparing the linked JSDoc and TSDoc @inheritdoc references and the related VSCode issue #301; done should include a decided compatibility behavior and corresponding specification or implementation changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100