Documentation does not explain what generics represent
- 主要言語
- TypeScript
- スター
- 25k
- フォーク
- 6.8k
- 平均マージ
- 1日 8時間
- マージ済み PR(30日)
- 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