Skip to content

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

Merged
vstinner merged 1 commit into
python:mainfrom
vstinner:fix_doc2
Jul 26, 2023
Merged

gh-107298: Fix Sphinx warnings in the C API doc#107302
vstinner merged 1 commit into
python:mainfrom
vstinner:fix_doc2

Conversation

@vstinner

@vstinnervstinner commented Jul 26, 2023•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

@vstinnervstinner added docs Documentation in the Doc dir skip news labels Jul 26, 2023
@bedevere-botbedevere-bot mentioned this pull request Jul 26, 2023
Closed
@vstinnervstinner 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

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

Copy link
Copy Markdown
Member

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

Comment threadDoc/c-api/buffer.rst Outdated
serhiy-storchaka
serhiy-storchaka reviewed Jul 26, 2023
View reviewed changes

@serhiy-storchakaserhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Mostly LGTM.

Comment threadDoc/c-api/buffer.rst Outdated
Comment threadDoc/c-api/tuple.rst Outdated
Comment threadDoc/c-api/type.rst Outdated
Comment threadDoc/c-api/unicode.rst Outdated
Comment threadDoc/c-api/unicode.rst Outdated
@vstinner

vstinner commented Jul 26, 2023

Copy link
Copy Markdown
MemberAuthor

@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

@serhiy-storchakaserhiy-storchaka left a comment

Copy link
Copy Markdown
Member

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.

Comment threadDoc/c-api/buffer.rst Outdated
CAM-Gerlach
CAM-Gerlach reviewed Jul 26, 2023
View reviewed changes

@CAM-GerlachCAM-Gerlach left a comment

Copy link
Copy Markdown
Member

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 !

Comment threadDoc/c-api/buffer.rst Outdated
Comment threadDoc/tools/.nitignore
@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:mainJul 26, 2023
@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-storchakaserhiy-storchaka added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jul 28, 2023
@miss-islington

miss-islington commented Jul 28, 2023

Copy link
Copy Markdown
Contributor

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

@miss-islington

miss-islington commented Jul 28, 2023

Copy link
Copy Markdown
Contributor

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

@miss-islington

miss-islington commented Jul 28, 2023

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

miss-islington commented Jul 28, 2023

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

bedevere-bot commented Jul 28, 2023

Copy link
Copy Markdown

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

@bedevere-botbedevere-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

bedevere-bot commented Jul 28, 2023

Copy link
Copy Markdown

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

@bedevere-botbedevere-bot removed the needs backport to 3.12 only 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes
@CAM-GerlachCAM-GerlachCAM-Gerlach left review comments
@Fidget-SpinnerFidget-SpinnerFidget-Spinner left review comments

Assignees

@vstinnervstinner

Labels

docsDocumentation in the Doc dirskip 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