microsoft / microsoft/TypeScript

Quick info for parameter redundantly shows @param tag

Offen
#26,876 2 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Committed Domain: LS: Quick Info Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

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.

param

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der TypeScript 3.1.0-dev.20180830-Reproduktion: Untersuchen Sie quick info für den Parameter p, wenn dessen JSDoc ein @param-Tag enthält. Bestätigen Sie, dass die aktuelle Ausgabe die Parameterdokumentation wiederholt, und überprüfen Sie anschließend, dass quick info die Dokumentation nur einmal anzeigt, ohne anderes JSDoc-Verhalten zu ändern.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
developer-experience
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.