microsoft / microsoft/node-jsonc-parser

Enums are not documented

Offen
#49 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature-request
Vorherrschende Sprache
TypeScript
Sterne
759
Forks
66
Ø Merge
5 T. 10 Std.
Gemergte PRs (30 T.)
7

Beschreibung

The only documentation for this library appears to be the README. However, this documentation is incomplete. The README documentation references several "enum-type" types, such as SyntaxKind (an enum{}) or NodeType (a union type supporting seven strings). Without knowing the allowed values of these enums, the library is not usable.

Clicking around in the github repo, I found src/main.ts, an extremely readable file with comments documenting the entire interface including the enums. I was able to use this to write my code. However a less experienced coder might not think to look for documentation in the src/ folder.

Expected behavior

All items from src/main.ts should be included in the README documentation, including the enums.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

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

Beginne damit, die Schnittstellenkommentare in src/main.ts zu lesen und sie mit der aktuellen README zu vergleichen. Dokumentiere alle Elemente aus src/main.ts, einschließlich der zulässigen Werte für SyntaxKind und NodeType. Fertig ist die Aufgabe, wenn die README die vollständige Schnittstelle abdeckt, sodass Leser nicht den Inhalt von src/ untersuchen müssen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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