io.BufferedReader.peek(): Documentation differs from Implementation

未关闭
#50,061 25 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

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

调研方向

Start with the current implementation and documentation for io.BufferedReader.peek(), then compare them with the attached peek.diff, peek2.diff, peek3.diff, peek4.diff, and peek-one-byte.patch files. Confirm the documented minimum return behavior against the implementation and update the documentation so it accurately describes the behavior.

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

描述

docs stdlib topic-IO type-bug
BPO 5811
Nosy @ncoghlan, @pitrou, @benjaminp, @vadmium, @desbma
Files
  • peek.diff
  • peek2.diff
  • peek3.diff
  • peek4.diff
  • peek-one-byte.patch: Document ≥ 1 byte returned
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = None
created_at = <Date 2009-04-22.06:15:51.564>
labels = ['type-bug', 'library', 'docs']
title = 'io.BufferedReader.peek(): Documentation differs from Implementation'
updated_at = <Date 2020-09-21.18:05:58.451>
user = 'https://bugs.python.org/trott'

    bugs.python.org fields:

    activity = <Date 2020-09-21.18:05:58.451>
actor = 'desbma'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Library (Lib)']
creation = <Date 2009-04-22.06:15:51.564>
creator = 'trott'
dependencies = []
files = ['14281', '14282', '14304', '14305', '37661']
hgrepos = []
issue_num = 5811
keywords = ['patch']
message_count = 25.0
messages = ['86274', '86275', '86276', '89311', '89312', '89313', '89314', '89315', '89324', '89326', '89327', '89328', '89329', '89340', '89349', '89366', '89388', '89389', '89399', '89400', '89401', '189599', '233750', '233801', '235024']
nosy_count = 8.0
nosy_names = ['ncoghlan', 'pitrou', 'benjamin.peterson', 'trott', 'conf', 'docs@python', 'martin.panter', 'desbma']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue5811'
versions = ['Python 2.7', 'Python 3.2', 'Python 3.4']

    主要语言
    Python
    星标
    77.2k
    派生
    36k
    平均合并
    1 天 9 小时
    30 天内合并 PR
    558

    贡献指南

    打开贡献指南

    从这里开始

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

    python/cpython 的其他 Issue

    查看 python/cpython 的全部 Issue

    相似的 Issue

    更多 Python Issue

    把新 issue 发到你的邮箱

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