python / python/cpython

socket.recvfrom(): docs should warn about packet truncation when bufsize is insufficient

Offen
#78,798 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

BPO 34617
Nosy @aneesahmed777

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 2018-09-09.22:21:11.308>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'socket.recvfrom(): docs should warn about packet truncation when bufsize is insufficient'
updated_at = <Date 2018-09-09.22:21:11.308>
user = 'https://github.com/aneesahmed777'

bugs.python.org fields:

activity = <Date 2018-09-09.22:21:11.308>
actor = 'Anees Ahmed'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-09-09.22:21:11.308>
creator = 'Anees Ahmed'
dependencies = []
files = []
hgrepos = []
issue_num = 34617
keywords = []
message_count = 1.0
messages = ['324901']
nosy_count = 2.0
nosy_names = ['docs@python', 'Anees Ahmed']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue34617'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5', 'Python 3.6', 'Python 3.7', 'Python 3.8']

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

Beginne damit, die Python-Dokumentation für socket.recvfrom() zu finden, und prüfe, wie dort das Argument bufsize und die zurückgegebenen Paketdaten beschrieben werden. Aktualisiere die Dokumentation, um darauf hinzuweisen, dass ein unzureichender bufsize das Paket abschneiden kann, und überprüfe anschließend die gerenderte Dokumentation auf eine klare und korrekte Formulierung.

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
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

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