microsoft / microsoft/TypeScript-Website
Somewhat unfortunate example on void return type on a fetching function
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 2.6k
- Forks
- 1.5k
- Ø Merge
- 2 T. 2 Std.
- Gemergte PRs (30 T.)
- 7
Beschreibung
https://github.com/microsoft/TypeScript-Website/blame/0612591abc2d8292c8ddd084b5fb264f203b7026/packages/documentation/copy/en/declaration-files/Do's and Don'ts.md#L81
Sorry if this is overthinking - i am new to typescript.
You are giving a DO example with an interface called "Fetcher" that defines getObject but returning nothing aka void. I think I got the point of "Do write callback parameters as non-optional", but the context is somewhat unfortunate. Maybe there can be thought of a better example for non-optional callback parameters?
Another way to phrase my thought: Is it a DO to use return type void on a getter-Method?
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne in packages/documentation/copy/en/declaration-files/Do's and Don'ts.md beim verlinkten Beispiel um Zeile 81. Lies die umgebende Anleitung zu nicht-optionalen Callback-Parametern und beurteile, ob das Fetcher-Beispiel diesen Punkt klar von der Frage eines void-Rückgabetyps unterscheidet. Erledigt ist die Aufgabe, wenn das Beispiel oder die Formulierung die beabsichtigte Anleitung besser vermittelt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 38/100