Advise to use typing.IO sparingly
オープン
まだ誰も着手していません。
docs
topic-typing
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 36k
- PR マージ指標
- PR 指標を取得中
説明
Documentation
typing.IO and subclasses typing.TextIO and typing.BinaryIO are a bit of a legacy feature and should be used sparingly. We should document better alternatives. I'm preparing a PR with some suggestions.
(Cc @gvanrossum @JelleZijlstra @AlexWaygood)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
この issue は typing.IO、typing.TextIO、typing.BinaryIO のドキュメントに関するものですが、ファイル、テスト、ドキュメントの入口は指定されていません。まず関連する typing のドキュメントを見つけ、報告者が準備している代替案を確認してください。これらの型をいつ控えめに使用すべきかをドキュメントで明確に案内し、より良い代替案を提示できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100