python / python/cpython

HOWTO for socket programming and select documentation contradict

Open
#89,945 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.10 3.11 3.9 (EOL) docs topic-socket type-bug
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 45787
Nosy @giampaolo, @AlexWaygood

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 2021-11-11.17:56:34.842>
labels = ['3.11', 'type-bug', '3.9', '3.10', 'docs']
title = 'HOWTO for socket programming and select documentation contradict'
updated_at = <Date 2021-11-11.17:56:34.842>
user = 'https://github.com/AlexWaygood'

bugs.python.org fields:

activity = <Date 2021-11-11.17:56:34.842>
actor = 'AlexWaygood'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-11-11.17:56:34.842>
creator = 'AlexWaygood'
dependencies = []
files = []
hgrepos = []
issue_num = 45787
keywords = []
message_count = 1.0
messages = ['406167']
nosy_count = 4.0
nosy_names = ['giampaolo.rodola', 'neologix', 'docs@python', 'AlexWaygood']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue45787'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the socket programming HOWTO with the select documentation, using the linked BPO issue 45787 for context. Identify the specific statements that contradict each other, then update the relevant documentation so the guidance is consistent and verify the rendered text and documentation checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, networking
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.