SocketType documentation misleading
Open
Nobody has claimed this yet.
docs
extension-modules
topic-socket
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 44261 |
|---|---|
| Nosy | @srittau, @JelleZijlstra |
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-05-28.15:21:42.596>
labels = ['docs']
title = 'SocketType documentation misleading'
updated_at = <Date 2021-05-29.23:00:46.252>
user = 'https://github.com/srittau'
bugs.python.org fields:
activity = <Date 2021-05-29.23:00:46.252>
actor = 'JelleZijlstra'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-05-28.15:21:42.596>
creator = 'srittau'
dependencies = []
files = []
hgrepos = []
issue_num = 44261
keywords = []
message_count = 2.0
messages = ['394665', '394743']
nosy_count = 3.0
nosy_names = ['srittau', 'docs@python', 'JelleZijlstra']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue44261'
versions = []
Linked PRs
- gh-126272
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the SocketType documentation and linked PR gh-126272, then compare the current wording with the documented behavior. Done means the misleading documentation is clarified and the relevant documentation checks pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100