Skip to content

gh-107924: re-order os.sendfile() flag documentation #107926

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.

Sign up for GitHub

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

Jump to bottom
Merged
hugovk merged 3 commits into from
Sep 7, 2023
Merged

gh-107924: re-order os.sendfile() flag documentation #107926

hugovk merged 3 commits into from
Sep 7, 2023

Conversation

@calestyo
Copy link
Contributor

@calestyo calestyo commented Aug 14, 2023 •
edited by github-actions bot
Loading

This should fix #107924. I didn't merge the two flag sections as mentioned there, cause the one for SF_NOCACHE has some extra description, and merging that would also be ugly, I guess.

Cheers,
Chris.

📚 Documentation preview 📚: https://cpython-previews--107926.org.readthedocs.build/

@bedevere-bot bedevere-bot mentioned this pull request Aug 14, 2023
Closed
2 tasks
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Aug 14, 2023
@calestyo
Copy link
Contributor Author

calestyo commented Aug 14, 2023

Updated the first commit. I've saw that the introducing text also names the various file types and I hadn't added socket to that list before.

AA-Turner
AA-Turner reviewed Aug 14, 2023
View reviewed changes
@calestyo
pythongh-107924: re-order os.sendfile() flag documentation
0d3b527 
Signed-off-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
@calestyo calestyo changed the title gh-107924: improve os docs gh-107924: re-order os.sendfile() flag documentation Aug 15, 2023
AA-Turner
AA-Turner reviewed Aug 15, 2023
View reviewed changes
@AA-Turner
Copy link
Member

AA-Turner commented Aug 21, 2023

Note: will need manual backport for 3.11.

A

@calestyo
Copy link
Contributor Author

calestyo commented Aug 21, 2023

Shall I do the backport? And is it even necessary at all? I mean it's just a cosmetic ordering.

hugovk
hugovk approved these changes Sep 7, 2023
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks!

Yes, it would be good if you could do the backport for 3.11.

Two reasons:

  • The 3.11 docs are the ones served at https://docs.python.org/3/, we want people to see this fix
  • If we don't backport this, but then backport another fix, we can end up with merge conflicts. It's usually easier to keep them in sync.

@hugovk hugovk merged commit 403ab13 into python:main Sep 7, 2023
@miss-islington
Copy link
Contributor

miss-islington commented Sep 7, 2023

Thanks @calestyo for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

miss-islington commented Sep 7, 2023

Sorry, @calestyo and @hugovk, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 403ab1306a6e9860197bce57eadcb83418966f21 3.11

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 7, 2023
@calestyo @hugovk @miss-islington
pythongh-107924: re-order os.sendfile() flag documentation (pythonGH-…
a3d60a6 
…107926)

(cherry picked from commit 403ab13)

Co-authored-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot
Copy link

bedevere-bot commented Sep 7, 2023

GH-109099 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Sep 7, 2023
Yhg1s pushed a commit that referenced this pull request Sep 8, 2023
@miss-islington @calestyo @hugovk
[3.12] gh-107924: re-order os.sendfile() flag documentation (GH-107926)…
b27ca96 
… (#109099)

gh-107924: re-order os.sendfile() flag documentation (GH-107926)
(cherry picked from commit 403ab13)

Co-authored-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot
Copy link

bedevere-bot commented Sep 9, 2023

GH-109178 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Sep 9, 2023
hugovk added a commit to hugovk/cpython that referenced this pull request Sep 9, 2023
@calestyo @hugovk
pythongh-107924: re-order os.sendfile() flag documentation (python#10…
e051557 
…7926)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
(cherry picked from commit 403ab13)
hugovk added a commit that referenced this pull request Sep 9, 2023
@hugovk @calestyo
[3.11] gh-107924: re-order os.sendfile() flag documentation (#107926) (…
77356f6 
…#109178)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
@hugovk
Copy link
Member

hugovk commented Sep 9, 2023

I did the 3.11 backport, thanks again for the issue and fix!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

@AA-Turner AA-Turner AA-Turner approved these changes

Assignees

@hugovk hugovk

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

os.sendfile() flags improperly ordered in documentation

5 participants

@calestyo @AA-Turner @miss-islington @bedevere-bot @hugovk