Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-128319: Add missing server class attributes to socketserver docs #128320

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

stephen-hansen
Copy link
Contributor

@stephen-hansen stephen-hansen commented Dec 28, 2024

Just doing some cleanup of the socketserver docs regarding class attributes as mentioned in the linked issue.

  • Move address_family attribute from instance attributes to class attributes.
  • Document allow_reuse_port.
  • Document max_packet_size (note UDP only).
  • Add note to request_queue_size to denote TCP only.

📚 Documentation preview 📚: https://cpython-previews--128320.org.readthedocs.build/

Copy link
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this :)

Doc/library/socketserver.rst Outdated Show resolved Hide resolved
Doc/library/socketserver.rst Outdated Show resolved Hide resolved
Doc/library/socketserver.rst Outdated Show resolved Hide resolved
Doc/library/socketserver.rst Show resolved Hide resolved
Doc/library/socketserver.rst Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

3 participants