Microsoft/TypeScript

lib.dom.d.ts should escape html elements in jsdoc comments

Aperta

#44.038 aperta il 11 mag 2021

Vedi su GitHubGuida contributor
 (5 commenti) (0 reazioni) (0 assegnatari)TypeScript (13.395 fork)batch import
Experience EnhancementHelp WantedSuggestion

Metriche repository

Star
 (108.860 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

lib Update Request

Configuration Check

My compilation target is ES2020 and my lib is the default.

Missing / Incorrect Definition

For html elements such as HTMLScriptElement, the JSDoc includes <script>. This causes VS Code to drop the entire body of the comment

Sample Code

const a: HTMLScriptElement // hover over HTMLScriptElement

Proposal

These JSDoc comments should escape any html in the comments. I suggest using markdown inline code instead:

/** HTML `<script>` elements expose the HTMLScriptElement interface ... */
interface HTMLScriptElement extends HTMLElement {

Guida contributor

Direzione di ricerca
Escape i tag HTML nei commenti JSDoc per elementi DOM come HTMLScriptElement per evitare che VS Code elimini il corpo del commento.
Tech stack
typescript
Dominio
documentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70