python / python/cpython

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

オープン
#78,798 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

3.7 (EOL) 3.8 (EOL) docs topic-socket type-feature
主要言語
Python
スター
77.2k
フォーク
36k
PR マージ指標
PR 指標を取得中

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、socket.recvfrom() の Python ドキュメントを見つけ、bufsize 引数と返されるパケットデータがどのように説明されているかを確認します。bufsize が不十分だとパケットが切り詰められる可能性があることを警告するようドキュメントを更新し、その後、レンダリングされたドキュメントを確認して、明確で正確な文言になっていることを確かめます。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。