Argument Clinic How-To needs more examples
オープン
まだ誰も着手していません。
type-feature
- 主要言語
- Python
- スター
- 2.1k
- フォーク
- 1k
- 平均マージ
- 2日 12時間
- マージ済み PR（30日）
- 12
説明
Documentation
Currently, the example for AC How-To is the method _pickle.Pickler.dump. I think it is not proper since it cannot cover all cases and makes readers confused. A more intuitive example should be considered to replace the current one.
Linked PRs
- python/cpython#106800
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Argument Clinic How-Toを読み、現在の_pickle.Pickler.dumpの例を確認してください。ガイドで扱う必要があるケースと比較し、必要に応じて、例をより直感的なものに置き換えるか、例を追加してください。ドキュメントは読者を混乱させないものにし、リンク先のPRで合意された変更を反映する必要があります。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100