microsoft / microsoft/TypeScript
Type name in @throws not rendered as a link
Aperta
Nessuno ha ancora preso questa issue.
Domain: JSDoc
Help Wanted
Possible Improvement
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.4k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
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}
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia riproducendo l’esempio JSDoc con @throws {Error} e traccia il percorso di rendering JSDoc di TypeScript; l’issue non indica alcun file sorgente né alcun test. Il lavoro è completato quando il nome del tipo viene renderizzato come un link anziché come il testo letterale {Error}.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- documentation
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100