microsoft / microsoft/TypeScript
lib.dom.d.ts should escape html elements in jsdoc comments
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
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 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 con il lib.dom.d.ts generato e il TypeScript-DOM-lib-generator menzionato nell’issue. Esamina il JSDoc di HTMLScriptElement e verifica che l’HTML, come <script>, sia sottoposto a escape o rappresentato come codice inline, in modo che VS Code conservi il commento completo quando si passa il mouse su HTMLScriptElement.
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
- Specificata chiaramente
- Idoneità per principianti
- 35/100