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-107298: Fix Sphinx warnings in the C API doc #107302

Merged
merged 1 commit into from
Jul 26, 2023
Merged

gh-107298: Fix Sphinx warnings in the C API doc #107302

merged 1 commit into from
Jul 26, 2023

Conversation

vstinner
Copy link
Member

@vstinner vstinner commented Jul 26, 2023 •
edited by github-actions bot
Loading

@vstinner vstinner added docs Documentation in the Doc dir skip news labels Jul 26, 2023
@bedevere-bot bedevere-bot mentioned this pull request Jul 26, 2023
Closed
@vstinner vstinner mentioned this pull request Jul 26, 2023
Closed
@serhiy-storchaka serhiy-storchaka self-requested a review July 26, 2023 17:29
Fidget-Spinner
Fidget-Spinner reviewed Jul 26, 2023
View reviewed changes
Copy link
Member

@Fidget-Spinner Fidget-Spinner left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Everything LGTM except for one comment I have.

I have cross referenced the preview docs with the current one in 3.12

Doc/c-api/buffer.rst Outdated Show resolved Hide resolved
serhiy-storchaka
serhiy-storchaka reviewed Jul 26, 2023
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Mostly LGTM.

Doc/c-api/buffer.rst Outdated Show resolved Hide resolved
Doc/c-api/tuple.rst Outdated Show resolved Hide resolved
Doc/c-api/type.rst Outdated Show resolved Hide resolved
Doc/c-api/unicode.rst Outdated Show resolved Hide resolved
Doc/c-api/unicode.rst Outdated Show resolved Hide resolved
@vstinner
Copy link
Member Author

@serhiy-storchaka: I updated my PR, would you mind to review the updated PR?

serhiy-storchaka
serhiy-storchaka approved these changes Jul 26, 2023
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM after fixing the duplicated link.

Doc/c-api/buffer.rst Outdated Show resolved Hide resolved
CAM-Gerlach
CAM-Gerlach reviewed Jul 26, 2023
View reviewed changes
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

Aside from the remaining issue in Doc/c-api/tuple.rst that should either be fixed (I help via a commit to your branch if you want, since its basically a mechanical task) or removed from .nitignore, and Serhiy's one comment, LGTM, thanks—excellent work here, @vstinner !

Doc/c-api/buffer.rst Outdated Show resolved Hide resolved
Doc/tools/.nitignore Show resolved Hide resolved
@vstinner
pythongh-107298: Fix Sphinx warnings in the C API doc
5b0984e 
* Update Doc/tools/.nitignore
* Fix BufferedIOBase.write() link in buffer.rst
@vstinner vstinner merged commit 391e03f into python:main Jul 26, 2023
15 checks passed
@vstinner vstinner deleted the fix_doc2 branch July 26, 2023 23:41
jtcave pushed a commit to jtcave/cpython that referenced this pull request Jul 27, 2023
@vstinner @jtcave
pythongh-107298: Fix Sphinx warnings in the C API doc (python#107302)
83d167b 
* Update Doc/tools/.nitignore
* Fix BufferedIOBase.write() link in buffer.rst
@serhiy-storchaka serhiy-storchaka added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Jul 28, 2023
@miss-islington
Copy link
Contributor

Thanks @vstinner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

Sorry, @vstinner, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 391e03fa05b80d17a14ac88d30c974fa2fa00adb 3.11

@miss-islington
Copy link
Contributor

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

serhiy-storchaka pushed a commit to serhiy-storchaka/cpython that referenced this pull request Jul 28, 2023
@vstinner @serhiy-storchaka
[3.11] pythongh-107298: Fix Sphinx warnings in the C API doc (pythonG…
efcd950 
…H-107302)

* Update Doc/tools/.nitignore
* Fix BufferedIOBase.write() link in buffer.rst.
(cherry picked from commit 391e03f)

Co-authored-by: Victor Stinner <vstinner@python.org>
@bedevere-bot
Copy link

GH-107373 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 Jul 28, 2023
serhiy-storchaka pushed a commit to serhiy-storchaka/cpython that referenced this pull request Jul 28, 2023
@vstinner @serhiy-storchaka
[3.12] pythongh-107298: Fix Sphinx warnings in the C API doc (pythonG…
cf220d7 
…H-107302)

* Update Doc/tools/.nitignore
* Fix BufferedIOBase.write() link in buffer.rst.
(cherry picked from commit 391e03f)

Co-authored-by: Victor Stinner <vstinner@python.org>
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 bug and security fixes label Jul 28, 2023
serhiy-storchaka added a commit that referenced this pull request Jul 28, 2023
@serhiy-storchaka @vstinner
[3.12] gh-107298: Fix Sphinx warnings in the C API doc (GH-107302) (G…
ef7422a 
…H-107375)

(cherry picked from commit 391e03f)

Co-authored-by: Victor Stinner <vstinner@python.org>
serhiy-storchaka added a commit that referenced this pull request Jul 28, 2023
@serhiy-storchaka @vstinner
[3.11] gh-107298: Fix Sphinx warnings in the C API doc (GH-107302) (G…
dcfdfa5 
…H-107373)

(cherry picked from commit 391e03f)

Co-authored-by: Victor Stinner <vstinner@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@CAM-Gerlach CAM-Gerlach CAM-Gerlach left review comments

@Fidget-Spinner Fidget-Spinner Fidget-Spinner left review comments

Assignees

@vstinner vstinner

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.
6 participants
@vstinner @miss-islington @bedevere-bot @serhiy-storchaka @CAM-Gerlach @Fidget-Spinner