GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-107298: Fix Sphinx warnings in the C API doc by vstinner · Pull Request #107302 · python/cpython

Conversation

@vstinner

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

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member
  • Issue: Fix Sphinx warnings in the C API documentation #107298

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@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
Fix Sphinx warnings in the C API documentation #107298
Closed
@bedevere-bot bedevere-bot added the awaiting core review label Jul 26, 2023
@vstinner
vstinner force-pushed the fix_doc2 branch from ce998cf to 52bc1ab Compare July 26, 2023 17:03
@vstinner vstinner mentioned this pull request Jul 26, 2023
gh-106948: Doc config ignores more standard C functions #107301
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-Spinner Fidget-Spinner left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/c-api/buffer.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
serhiy-storchaka
serhiy-storchaka reviewed Jul 26, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Mostly LGTM.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/c-api/buffer.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/c-api/tuple.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/c-api/type.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/c-api/unicode.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/c-api/unicode.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@vstinner

vstinner commented Jul 26, 2023

Copy link
Copy Markdown
Member Author

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
serhiy-storchaka
serhiy-storchaka approved these changes Jul 26, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/c-api/buffer.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Jul 26, 2023
CAM-Gerlach
CAM-Gerlach reviewed Jul 26, 2023
View reviewed changes

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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 !

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/c-api/buffer.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/tools/.nitignore Resolved

Uh oh!

There was an error while loading. Please reload this page.
@vstinner
vstinner force-pushed the fix_doc2 branch from 90675b6 to acc6808 Compare July 26, 2023 23:21
@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 force-pushed the fix_doc2 branch from acc6808 to 5b0984e Compare July 26, 2023 23:26
@vstinner
vstinner merged commit 391e03f into python:main Jul 26, 2023
@bedevere-bot bedevere-bot removed the awaiting merge label Jul 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-storchaka serhiy-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.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@miss-islington miss-islington assigned vstinner Jul 28, 2023
@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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
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 <[email protected]>
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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 <[email protected]>
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-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 <[email protected]>
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 <[email protected]>
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

Uh oh!

There was an error while loading. Please reload this page.

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.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@vstinner @miss-islington @bedevere-bot @serhiy-storchaka @CAM-Gerlach @Fidget-Spinner
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.