python / python/cpython

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

Ouverte
#78,798 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

3.7 (EOL) 3.8 (EOL) docs topic-socket type-feature
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Métriques de merge des PR
Métriques de PR en attente

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser la documentation Python de socket.recvfrom() et examinez la manière dont son argument bufsize et les données du paquet renvoyées y sont décrits. Mettez à jour la documentation pour avertir qu’un bufsize insuffisant peut tronquer le paquet, puis vérifiez la documentation rendue afin de vous assurer que la formulation est claire et exacte.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.