tarfile stream restrictions should be documented
オープン
まだ誰も着手していません。
docs
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 35.9k
- PR マージ指標
- PR 指標を取得中
説明
Documentation
tarfile documentation mentions stream mode only in tarfile.open, and says "However, such a TarFile object is limited in that it does not allow random access, see Examples."
The examples section does not showcase stream mode at all.
I believe all methods that might be unavailable in stream mode should be documented as such.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
tarfile.open のドキュメントとその Examples セクションから始め、次に、ランダムアクセスを必要とする操作について、ドキュメントに記載された TarFile のメソッドを確認します。該当する箇所ではストリームモードの制限を文書化し、ストリームモードを示す例を追加して、完成したドキュメントで利用できない操作が明確に示されるようにします。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100