python / python/cpython

tarfile stream restrictions should be documented

未关闭
#135,253 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

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.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

先查看 tarfile.open 文档及其 Examples 部分,然后检查已记录的 TarFile 方法,找出需要随机访问的操作。在适用的地方记录流模式的限制,并添加一个演示流模式的示例,确保生成的文档明确标识不可用的操作。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。