python / python/cpython

io.BufferedRWPair doc warning may need clarification

Offen
#82,776 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

3.7 (EOL) docs topic-IO type-bug
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

BPO 38595
Nosy @pitrou, @benjaminp

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 2019-10-26.05:19:33.715>
labels = ['type-bug', '3.7', 'docs']
title = 'io.BufferedRWPair doc warning may need clarification'
updated_at = <Date 2019-10-26.05:30:22.117>
user = 'https://bugs.python.org/rgov'

bugs.python.org fields:

activity = <Date 2019-10-26.05:30:22.117>
actor = 'rgov'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-10-26.05:19:33.715>
creator = 'rgov'
dependencies = []
files = []
hgrepos = []
issue_num = 38595
keywords = []
message_count = 2.0
messages = ['355404', '355405']
nosy_count = 5.0
nosy_names = ['pitrou', 'benjamin.peterson', 'stutzbach', 'docs@python', 'rgov']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue38595'
versions = ['Python 3.7']

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der Überprüfung der Dokumentation zu io.BufferedRWPair und des migrierten BPO-Issues 38595, einschließlich seiner beiden Kommentare. Finden Sie den im Issue erwähnten Warnhinweis und bestimmen Sie, welche Klarstellung erforderlich ist; die Arbeit ist abgeschlossen, wenn die relevante Dokumentation diesen Warnhinweis eindeutig erklärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
28/100

Neue Issues direkt in Ihr Postfach

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