Microsoft/TypeScript

Type name in @throws not rendered as a link

Open

#59,578 opened on Aug 9, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (6,726 forks)batch import
Domain: JSDocHelp WantedPossible Improvement

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

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

Research direction
Investigate how TypeScript's JSDoc parser and renderer handle @throws tags with type names, and modify the rendering logic to convert type names inside curly braces into hyperlinks.
Tech stack
typescript
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptJSDoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70