Argument Clinic: add reference for the DSL
オープン
まだ誰も着手していません。
type-feature
- 主要言語
- Python
- スター
- 2.1k
- フォーク
- 1k
- 平均マージ
- 2日 12時間
- マージ済み PR(30日)
- 12
説明
We need a better reference for the Argument Clinic DSL:
- legal syntax for the "function name" line
- legal syntax for parameter lines
- legal syntax for docstrings
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、既存の Argument Clinic ドキュメントと devguide 内の現在の DSL 参照をすべて見つけます。ドキュメント化されている範囲を、要求されている関数名の構文、パラメーター行の構文、docstring の構文と比較します。3 つすべての領域について、使用できる構文を説明するリファレンスがあれば作業は完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100