microsoft / microsoft/TypeScript
Type name in @throws not rendered as a link
Open
Nobody has claimed this yet.
Domain: JSDoc
Help Wanted
Possible Improvement
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
According to the JSDoc documentation you can put a type name after a @throws. Something like @throws {Error}. I would expect the type name to be rendered as a link, but it is rendered as {Error}
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 JSDoc example with @throws {Error} and trace TypeScript's JSDoc rendering path; the issue names no source file or test. Done means the type name is rendered as a link rather than the literal {Error} text.
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
- 45/100