socket module shutdown() constants SHUT_RD, etc not included in Constants section

[jweaver-ca]

Documentation

In documentation for socket module, the constants SHUT_RD, SHUT_WR, SHUT_RDWR are mentioned in the description for shutdown(), but they are missing from the Constants section on that page.

Linked PRs

• gh-122519: Adding socket module shutdown() constants description #122543
• [3.13] gh-122519: Adding socket module shutdown() constants description (GH-122543) #123093
• [3.12] gh-122519: Adding socket module shutdown() constants description (GH-122543) #123094

[picnixz]

We don't document all of them one by one, but I think we can document them using SHUT_* like that.

[Damien-Chen]

Hi @picnixz,
you means adding SHUT_* in the below field ?

[picnixz]

Mmh, perhaps not. Those (that you show) are generally used in arguments to the setsockopt() and getsockopt(). A dedicated category could be made for the SHUT_* constants, like for https://docs.python.org/3/library/socket.html#socket.SIO_RCVALL (it's a group of 3 constants for a specific function).

[Damien-Chen]

Ok, so make a category like the below and mention these argument are used to the socket.shutdown() method of socket object.
SHUT_RD
SHUT_WR
SHUT_RDWR

If my understanding is right ?
Thank you.

[picnixz]

Yes, something like that. Best is to see how the other constants are documented when they are grouped. You'll need to update the links to those constants as well.

[Damien-Chen]

I made a preliminary modification on documention, please help me check if there is anything need to change, thank you very much!