Microsoft/TypeScript

Type name in @throws not rendered as a link

Open

#59.578 geöffnet am 9. Aug. 2024

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (6.726 Forks)batch import
Domain: JSDocHelp WantedPossible Improvement

Repository-Metriken

Stars
 (48.455 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 17h) (9 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche, wie der JSDoc Parser und Renderer von TypeScript @throws Tags mit Typnamen verarbeitet, und ändere die Rendering Logik, um Typnamen in geschweiften Klammern in Hyperlinks umzuwandeln.
Tech Stack
typescript
Domain
documentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptJSDoc
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70