Some server class attributes are missing in socketserver docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
While working with socketserver recently I noticed that the allow_reuse_port class attribute is not documented but the allow_reuse_address attribute is.
In addition there's a couple of places we could clean up right now, for instance address_family is still grouped with the per-instance attributes rather than the class attributes, request_queue_size is only applicable to TCP, and there's another missing undocumented class attribute for specifying max packet size that is only applicable to UDP.
Linked PRs
- gh-128320
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 with the socketserver documentation and compare its class-attribute descriptions with Lib/socketserver.py around lines 185-198. Done means documenting allow_reuse_port, grouping address_family correctly, clarifying that request_queue_size applies to TCP, and documenting the UDP-only maximum packet-size attribute; gh-128320 is linked in the issue.
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
- Mostly clear
- Newbie friendliness
- 35/100