◐ Shell
reader mode source ↗
Skip to content

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

Merged
methane merged 3 commits into
python:masterfrom
gousaiyang:socket-sendrecvfd-doc
Apr 22, 2021
Merged

bpo-28724: Move socket.send_fds and socket.recv_fds documentation to the "Other functions" section#22608
methane merged 3 commits into
python:masterfrom
gousaiyang:socket-sendrecvfd-doc

Conversation

@gousaiyang

@gousaiyang gousaiyang commented Oct 9, 2020 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

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

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Oct 9, 2020
jstasiak
jstasiak approved these changes Nov 1, 2020
View reviewed changes

@jstasiak jstasiak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hide comment

Looks reasonable to me!

@github-actions

github-actions Bot commented Dec 17, 2020

Copy link
Copy Markdown

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 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

miss-islington commented Apr 22, 2021

Copy link
Copy Markdown
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
@gousaiyang @miss-islington
bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to righ… …
aefea09 
…t section (pythonGH-22608)

(cherry picked from commit 660592f)

Co-authored-by: Saiyang Gou <gousaiyang@163.com>
@bedevere-bot

bedevere-bot commented Apr 22, 2021

Copy link
Copy Markdown

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

@miss-islington

miss-islington commented Apr 22, 2021

Copy link
Copy Markdown
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

gousaiyang commented Apr 22, 2021

Copy link
Copy Markdown
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
@miss-islington @gousaiyang
bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to righ… …
87a392d 
…t section (GH-22608)

(cherry picked from commit 660592f)

Co-authored-by: Saiyang Gou <gousaiyang@163.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@jstasiak jstasiak jstasiak approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@methane methane

Labels

docs Documentation in the Doc dir skip news stale Stale PR or inactive for long period of time.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@gousaiyang @miss-islington @bedevere-bot @jstasiak @methane @the-knights-who-say-ni