Documentation does not explain what generics represent
- Langage dominant
- TypeScript
- Étoiles
- 25k
- Forks
- 6.8k
- Merge moyen
- 1 j 8 h
- PR mergées (30 j)
- 91
Description
#### 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
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par l’entrée MatDatepickerInputEvent dans la documentation de l’API du datepicker Angular Material et examinez la manière dont sa déclaration TypeScript est présentée. Documentez ce que représentent les paramètres de type S et D, en suivant le style utilisé pour les paramètres de type dans la documentation Java liée. Le travail est terminé lorsque les nouveaux contributeurs peuvent comprendre les deux génériques à partir de la documentation de l’API.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 68/100