Documentation does not explain what generics represent
- 主要语言
- TypeScript
- 星标
- 25k
- 派生
- 6.8k
- 平均合并
- 1 天 8 小时
- 30 天内合并 PR
- 91
描述
#### 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
贡献指南
调研方向
从 Angular Material datepicker API 文档中的 MatDatepickerInputEvent 条目开始,检查其 TypeScript 声明是如何呈现的。按照所链接的 Java 文档中展示的类型参数风格,记录类型参数 S 和 D 分别代表什么。完成的标准是新贡献者能够通过 API 文档理解这两个泛型。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- typescript
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 冷清
- 描述清晰度
- 基本清楚
- 新手友好度
- 68/100