microsoft / microsoft/TypeScript

Non-Nullable Objects in params don't have properties parsed

Offen
#32,783 7 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Domain: JSDoc Needs Investigation
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

TypeScript Version: 3.5.2

Search Terms: object param

Code

/**
 * Converts a type to a markdown string.
 * @param {!Object} [opts]
 * @param {boolean} [opts.narrow] Combine type and description.
*/

Expected behavior:

Screenshot 2019-08-09 at 21 08 50

Actual behavior:

Screenshot 2019-08-09 at 21 09 19

Playground Link:

Related Issues:

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

Es ist keine Datei und kein Test benannt. Beginne damit, das Verhalten aus dem JSDoc-Beispiel des Issues in TypeScript 3.5.2 zu reproduzieren, und verfolge dann den Parsing-Pfad für JSDoc-Parameter; fertig ist es, wenn die Eigenschaften des nicht-nullbaren Objektparameters wie im erwarteten Verhalten geparst werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

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