Skip to content
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

gh-127082: Replace "Windows only: ..." with the .. availability:: Windows directive in ctypes doc. #127099

Merged
merged 4 commits into from
Nov 22, 2024
Merged

gh-127082: Replace "Windows only: ..." with the .. availability:: Windows directive in ctypes doc. #127099

merged 4 commits into from
Nov 22, 2024

Conversation

junkmd
Copy link
Contributor

@junkmd junkmd commented Nov 21, 2024 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot added the docs Documentation in the Doc dir label Nov 21, 2024
@bedevere-app bedevere-app bot mentioned this pull request Nov 21, 2024
Closed
vstinner
vstinner approved these changes Nov 21, 2024
View reviewed changes
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

LGTM but it would be better to not reformat paragraphs to keep the change as small as possible: only change the first line of the modified paragraphs.

Eclips4
Eclips4 approved these changes Nov 21, 2024
View reviewed changes
Copy link
Member

@Eclips4 Eclips4 left a comment

Choose a reason for hiding this comment

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

LGTM. +1 to Victor's words.

@junkmd junkmd requested review from Eclips4 and vstinner November 21, 2024 23:29
@vstinner vstinner merged commit 3c770e3 into python:main Nov 22, 2024
25 checks passed
@vstinner vstinner added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Nov 22, 2024
@miss-islington-app
Copy link

Thanks @junkmd for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

Sorry, @junkmd and @vstinner, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 3c770e3f0978d825c5ebea98fcd654660e7e135f 3.13

@miss-islington-app
Copy link

Sorry, @junkmd and @vstinner, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 3c770e3f0978d825c5ebea98fcd654660e7e135f 3.12

@vstinner vstinner removed needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Nov 22, 2024
@vstinner
Copy link
Member

Merged, thanks.

Backports to 3.12 and 3.13 failed with a conflict. Do you want to try to backport the change manually to 3.13?

@junkmd
Copy link
Contributor Author

junkmd commented Nov 22, 2024

The replacement with directives included the newly added COMError in #126686.
Since the COMError section did not exist prior to Python 3.14, this likely caused the conflict.

Do you want to try to backport the change manually to 3.13?

Yes.
Please let me know what I should do.

@junkmd
Copy link
Contributor Author

junkmd commented Nov 22, 2024

I’ll try using cherry_picker as suggested by the miss-islington app.

@junkmd junkmd deleted the ctypes_doc_availability_directive branch November 22, 2024 09:22
junkmd added a commit to junkmd/cpython that referenced this pull request Nov 22, 2024
@junkmd
[3.13] pythongh-127082: Replace "Windows only" with the `availability…
3b77636 
…: Windows` in `ctypes` doc (pythonGH-127099)

(cherry picked from commit 3c770e3)

Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Nov 22, 2024

GH-127144 is a backport of this pull request to the 3.13 branch.

junkmd added a commit to junkmd/cpython that referenced this pull request Nov 22, 2024
@junkmd
[3.13] pythongh-127082: Replace "Windows only" with the `availability…
53f522d 
…: Windows` in `ctypes` doc (pythonGH-127099)

(cherry picked from commit 3c770e3)

Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Nov 22, 2024

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

vstinner pushed a commit that referenced this pull request Nov 22, 2024
@junkmd
[3.12] gh-127082: Replace "Windows only" with the `availability: Wind…
caad904 
…ows` in `ctypes` doc (GH-127099) (#127145)

(cherry picked from commit 3c770e3)
vstinner pushed a commit that referenced this pull request Nov 22, 2024
@junkmd
[3.13] gh-127082: Replace "Windows only" with the `availability: Wind…
af00c58 
…ows` in `ctypes` doc (GH-127099) (#127144)

(cherry picked from commit 3c770e3)
@junkmd junkmd mentioned this pull request Nov 24, 2024
Merged
ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025
@junkmd @ebonnal
pythongh-127082: Replace "Windows only" with the `availability: Windo…
a093e12 
…ws` in `ctypes` doc (python#127099)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Eclips4 Eclips4 Awaiting requested review from Eclips4

@vstinner vstinner Awaiting requested review from vstinner

Assignees

@vstinner vstinner

Labels
docs Documentation in the Doc dir skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@junkmd @vstinner @Eclips4