microsoft / microsoft/TypeScript
Quick info for parameter redundantly shows @param tag
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
TypeScript Version: 3.1.0-dev.20180830
Code
/**
* @param p
* Once upon a time there was a parameter named p.
* P lived in a function called f.
* Then a big bad wolf came and blew f down.
*/
function f(p: number): void {}
Expected behavior:
Documentation for p is shown only once.
Actual behavior:
Documentation is shown twice -- once as the normal documentation (good), once as documentation for the @param tag which is redundant since we took the documentation from there. This doubles the size of the quick info.

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 la riproduzione di TypeScript 3.1.0-dev.20180830: esamina quick info per il parametro p quando il relativo JSDoc contiene un tag @param. Conferma che l'output attuale ripeta la documentazione del parametro, quindi verifica che quick info presenti la documentazione una sola volta senza modificare altro comportamento di JSDoc.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- developer-experience
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 48/100