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

Offen
#50,061 25 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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']
    

    Vorherrschende Sprache
    Python
    Sterne
    77.2k
    Forks
    36k
    Ø Merge
    1 T. 9 Std.
    Gemergte PRs (30 T.)
    558

    Beitragsleitfaden

    Beitragsleitfaden öffnen

    Erste Schritte

    1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
    2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
    3. Forken Sie das Repository und arbeiten Sie in einem Branch.
    4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

    Mehr aus python/cpython

    Alle Issues in python/cpython

    Ähnliche Issues

    Weitere Issues zu Python

    Neue Issues direkt in Ihr Postfach

    Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.