Skip to content

bpo-28724: Move socket.send_fds and socket.recv_fds documentation to the "Other functions" section #22608

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

Merged
merged 3 commits into from
Apr 22, 2021

Conversation

gousaiyang
Copy link
Contributor

@gousaiyang gousaiyang commented Oct 9, 2020

Move socket.send_fds and socket.recv_fds documentation to the "Other functions" section, since they are module-level functions rather than methods of socket objects. Putting them in the "Socket Objects" section would make people incorrectly think that they are methods of socket objects, which is confusing.

https://bugs.python.org/issue28724

Copy link
Contributor

@jstasiak jstasiak left a comment

Choose a reason for hiding this comment

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

Looks reasonable to me!

@github-actions
Copy link

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Dec 17, 2020
@gousaiyang gousaiyang changed the title Move socket.send_fds and socket.recv_fds documentation to the "Other functions" section bpo-28724: Move socket.send_fds and socket.recv_fds documentation to the "Other functions" section Apr 22, 2021
@gousaiyang gousaiyang force-pushed the socket-sendrecvfd-doc branch from 2c461f7 to 0c875b3 Compare April 22, 2021 00:23
@methane methane merged commit 660592f into python:master Apr 22, 2021
@miss-islington
Copy link
Contributor

Thanks @gousaiyang for the PR, and @methane for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 22, 2021
…t section (pythonGH-22608)

(cherry picked from commit 660592f)

Co-authored-by: Saiyang Gou <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Apr 22, 2021
@bedevere-bot
Copy link

GH-25517 is a backport of this pull request to the 3.9 branch.

@miss-islington
Copy link
Contributor

Sorry, @gousaiyang and @methane, I could not cleanly backport this to 3.8 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 660592f67c0d825b06eb4a38ccc04b34a1f01f00 3.8

@gousaiyang
Copy link
Contributor Author

We don't need to backport this to 3.8 as those features are 3.9+.

@gousaiyang gousaiyang deleted the socket-sendrecvfd-doc branch April 22, 2021 04:12
miss-islington added a commit that referenced this pull request Apr 22, 2021
…t section (GH-22608)

(cherry picked from commit 660592f)

Co-authored-by: Saiyang Gou <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news stale Stale PR or inactive for long period of time.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants