Stop repeating input/output type info in docstrings
オープン
まだ誰も着手していません。
cuda.core
documentation
P1
- 主要言語
- Cython
- スター
- 3.4k
- フォーク
- 329
- 平均マージ
- 1日 23時間
- マージ済み PR（30日）
- 116
説明
I think Sphinx is able to figure out the types and keep them in the document by inspecting the typing info, which going forward should be our source of truth (https://github.com/NVIDIA/cuda-python/issues/312#issue-2746694448). We should not repeat ourselves.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ファイルもテストも指定されていません。まず、この issue の対象となっている docstring と型定義を読み、次に生成された Sphinx ドキュメントを確認してください。入力/出力型の冗長な宣言が削除され、型がレンダリングされたドキュメントに引き続き存在していれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100