microsoft / microsoft/TypeScript
Intellisense should inherit documentation for Interfaces.
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
When implementing an interface the intellisense feature is capable of detecting the description of the interface however it does not carry over any tags such as @param and @returns.
Below is a picture of an example:
You can see that the description is properly shown however the param and returns tag is not.
What is expected:
Contributor guide
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 reproducing the reported IntelliSense behavior with an interface containing documentation and @param/@returns tags, then inspect the TypeScript language-service path that supplies documentation for implemented interface members. Done means the implementing member shows the interface description together with the inherited parameter and return tags.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100