angular / angular/components

Documentation does not explain what generics represent

Abierto Apto para principiantes
#22,121 5 comentarios 0 reacciones 0 asignados Ver en GitHub
area: dev-infra docs P2
Lenguaje dominante
TypeScript
Estrellas
25k
Forks
6.8k
Merge medio
1 d 8 h
PR fusionados (30 d)
91

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con la entrada MatDatepickerInputEvent en la documentación de la API del datepicker de Angular Material e inspecciona cómo se presenta su declaración de TypeScript. Documenta qué representan los parámetros de tipo S y D, siguiendo el estilo para parámetros de tipo mostrado en la documentación de Java enlazada. Se considera terminado cuando las personas nuevas en el proyecto pueden entender ambos genéricos a partir de la documentación de la API.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
68/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.