angular / angular/components

Documentation does not explain what generics represent

Aperta Adatta ai principianti
#22,121 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub
area: dev-infra docs P2
Lingua principale
TypeScript
Stelle
25k
Fork
6.8k
Merge medio
1g 8h
PR unite (30g)
91

Descrizione

#### 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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dalla voce MatDatepickerInputEvent nella documentazione dell'API del datepicker di Angular Material e verifica come viene presentata la relativa dichiarazione TypeScript. Documenta cosa rappresentano i parametri di tipo S e D, seguendo lo stile per i parametri di tipo mostrato nella documentazione Java collegata. Il lavoro è completato quando chi contribuisce per la prima volta può comprendere entrambi i generics dalla documentazione dell'API.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.