Skip to content

gh-151396: Document socket.AddressFamily and socket.SocketKind#151495

Closed
zainnadeem786 wants to merge 1 commit into
python:mainfrom
zainnadeem786:gh-151396-document-socket-enums
Closed

gh-151396: Document socket.AddressFamily and socket.SocketKind#151495
zainnadeem786 wants to merge 1 commit into
python:mainfrom
zainnadeem786:gh-151396-document-socket-enums

Conversation

@zainnadeem786

@zainnadeem786 zainnadeem786 commented Jun 15, 2026

Copy link
Copy Markdown

Summary

Add explicit documentation entries for socket.AddressFamily and socket.SocketKind.

The AF_* and SOCK_* constants are already documented, but the enum classes themselves currently do not have Sphinx object entries. As a result, references to these exported classes cannot be resolved by Sphinx or intersphinx.

Changes

  • Add documentation entry for socket.AddressFamily
  • Add documentation entry for socket.SocketKind

Notes

Both classes are exported via socket.__all__ and are already part of the public API.

This is a documentation-only change.

Fixes #151396.

@python-cla-bot

python-cla-bot Bot commented Jun 15, 2026

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33143214 | 📁 Comparing 46cb8df against main (ecbd31e)

  🔍 Preview build  

1 file changed
± library/socket.html

@picnixz

picnixz commented Jun 15, 2026

Copy link
Copy Markdown
Member

Someone already proposed to open a PR and you did not let them enough time to reply. Please be mindful of other contributors and please read the following:

@picnixz picnixz closed this Jun 15, 2026
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 skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

socket.AddressFamily and socket.SocketKind are undocumented

2 participants