Can inherit doc also copy the TSDoc when I hover?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Honestly don't know how @inheritDoc or @inheritdoc works. Can't we also make it copy the docs so that we don't have to repeat it? Will that be a valid use-case? Just wondering.
I'm assuming this tag is useful for library devs but is this tag just not useful for application devs?
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 reviewing the existing @inheritDoc and @inheritdoc behavior described in the TSDoc specification, along with the hover examples attached to the issue. Clarify whether inherited comments should be copied into hover documentation and define the expected behavior for library and application code before identifying implementation work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100