microsoft / microsoft/TypeScript

Improving documentation for built-in type declarations

Offen
#40,024 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

Looking at for instance lib.dom.d.ts, what I notice is that the documentation isn't what it could be. Is there any policy w.r.t. improving on this? I think the benefits of better docs are quite obvious, for instance adding examples or stating browser support for certain features.

However I wonder if:

  • Since the file is already quite large, and adding documentation could blow it up like 100x, would this cause any performance issues (in editors)? If so, is there a way around it?
  • The best documentation on these things (that I know of) are on MDN. A nice start could be to link/auto add some docs from there, if the licensing allows it (https://wiki.developer.mozilla.org/en-US/docs/MDN/About#Copyrights_and_licenses). I think it does at least in part.

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

Beginne mit der Durchsicht von lib.dom.d.ts und den Fragen des Issues zur Größe der Dokumentation, zur Editorleistung und zur MDN-Lizenzierung. Vergleiche die bestehenden Deklarationen mit dem referenzierten MDN-Material. Dieses Issue ist erst abgeschlossen, nachdem sich das Projekt auf eine Dokumentationsrichtlinie und einen konkreten, akzeptierten Ansatz geeinigt hat.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

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