angular / angular/components

Documentation does not explain what generics represent

Offen Anfängerfreundlich
#22,121 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area: dev-infra docs P2
Vorherrschende Sprache
TypeScript
Sterne
25k
Forks
6.8k
Ø Merge
1 T. 8 Std.
Gemergte PRs (30 T.)
91

Beschreibung

#### Documentation Feedback

In docs it would be helpful to have documentaion for declared TS generics.
For example, I open `MatDatepickerInputEvent` [docs](https://material.angular.io/components/datepicker/api#MatDatepickerInputEvent) and see `S` and `D` generics.
And from the docs it's unclear what these `S` and `D` represent!

I think it should be documented similar to as Java does it.
For example, a [docs](https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/function/Function.html) of Java's standard type `Function` contain a section

> Type Parameters:
> T - the type of the input to the function
> R - the type of the result of the function

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie mit dem Eintrag MatDatepickerInputEvent in der Angular Material-Datepicker-API-Dokumentation und untersuchen Sie, wie seine TypeScript-Deklaration dargestellt wird. Dokumentieren Sie, wofür die Typparameter S und D stehen, und orientieren Sie sich dabei am Stil für Typparameter, der in der verlinkten Java-Dokumentation gezeigt wird. Die Aufgabe ist abgeschlossen, wenn neue Mitwirkende beide Generics anhand der API-Dokumentation verstehen können.

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
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
68/100

Neue Issues direkt in Ihr Postfach

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