gh-151396: Document socket.AddressFamily and socket.SocketKind#151495
Closed
zainnadeem786 wants to merge 1 commit into
Closed
gh-151396: Document socket.AddressFamily and socket.SocketKind#151495zainnadeem786 wants to merge 1 commit into
zainnadeem786 wants to merge 1 commit into
Conversation
Documentation build overview
|
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: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add explicit documentation entries for
socket.AddressFamilyandsocket.SocketKind.The
AF_*andSOCK_*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
socket.AddressFamilysocket.SocketKindNotes
Both classes are exported via
socket.__all__and are already part of the public API.This is a documentation-only change.
Fixes #151396.
socket.AddressFamilyandsocket.SocketKindare undocumented #151396