python / python/cpython

socket._GLOBAL_DEFAULT_TIMEOUT being an object() makes for ugly docstrings, can be better

Open
#91,225 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.11 stdlib topic-socket type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 47069
Nosy @ferdnyc

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 2022-03-19.20:18:03.311>
labels = ['type-feature', 'library', '3.11']
title = 'socket._GLOBAL_DEFAULT_TIMEOUT being an object() makes for ugly docstrings, can be better'
updated_at = <Date 2022-03-19.20:18:03.311>
user = 'https://github.com/ferdnyc'

bugs.python.org fields:

activity = <Date 2022-03-19.20:18:03.311>
actor = 'ferdnyc'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2022-03-19.20:18:03.311>
creator = 'ferdnyc'
dependencies = []
files = []
hgrepos = []
issue_num = 47069
keywords = []
message_count = 1.0
messages = ['415568']
nosy_count = 1.0
nosy_names = ['ferdnyc']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue47069'
versions = ['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

Start by locating socket._GLOBAL_DEFAULT_TIMEOUT in the CPython source and inspect the docstrings or generated representations affected by its object() value. Determine what clearer presentation the issue can support, then check nearby socket tests for a suitable place to verify the result. Done means the relevant documentation is less awkward without changing the issue's intended timeout behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
networking
Issue type
Feature
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.