Skip to content

gh-101100: Fix Sphinx warnings in 'Buffer Object Structures' documentation#151058

Merged
StanFromIreland merged 1 commit into
python:mainfrom
czinck:gh-101100-typeobj-warnings
Jun 8, 2026
Merged

gh-101100: Fix Sphinx warnings in 'Buffer Object Structures' documentation#151058
StanFromIreland merged 1 commit into
python:mainfrom
czinck:gh-101100-typeobj-warnings

Conversation

@czinck
Copy link
Copy Markdown
Contributor

@czinck czinck commented Jun 7, 2026 •
edited by bedevere-app Bot
Loading

This uses literals instead of c:expr when referencing view->obj, fixing sphinx warnings when processing typeobj.rst. view is a local parameter with no documented target, so c:expr emitted a broken cross-reference. This now matches the buffer documentation for these members, eg https://github.com/python/cpython/blob/main/Doc/c-api/buffer.rst?plain=1#L459.

image

@czinck czinck requested a review from ZeroIntensity as a code owner June 7, 2026 19:23
@python-cla-bot
Copy link
Copy Markdown

python-cla-bot Bot commented Jun 7, 2026 •
edited
Loading

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app Bot added awaiting review docs Documentation in the Doc dir skip news labels Jun 7, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jun 7, 2026
@czinck czinck force-pushed the gh-101100-typeobj-warnings branch from 71c806a to 1b13e0d Compare June 7, 2026 19:27
@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented Jun 7, 2026

Documentation build overview

📚 cpython-previews | 🛠️ Build #33029479 | 📁 Comparing 1b13e0d against main (4084141)

  🔍 Preview build  

1 file changed
± c-api/typeobj.html

@StanFromIreland StanFromIreland changed the title gh-101100: fix sphinx warnings in PyTypeObject documentation gh-101100: Fix Sphinx warnings in 'Buffer Object Structures' documentation Jun 8, 2026
@StanFromIreland StanFromIreland merged commit a187330 into python:main Jun 8, 2026
34 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jun 8, 2026
@StanFromIreland
Copy link
Copy Markdown
Member

StanFromIreland commented Jun 8, 2026

Merged, thanks!

@StanFromIreland StanFromIreland added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Jun 8, 2026
@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented Jun 8, 2026

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

@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented Jun 8, 2026

Thanks @czinck for the PR, and @StanFromIreland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented Jun 8, 2026

Thanks @czinck for the PR, and @StanFromIreland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Jun 8, 2026

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Jun 8, 2026
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Jun 8, 2026

GH-151072 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Jun 8, 2026
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Jun 8, 2026

GH-151073 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jun 8, 2026
StanFromIreland pushed a commit that referenced this pull request Jun 8, 2026
@miss-islington @czinck
[3.15] gh-101100: Fix Sphinx warnings in 'Buffer Object Structures' d…
1f3ee92 
…ocumentation (GH-151058)

(cherry picked from commit a187330)

Co-authored-by: Christian Zinck <christian.zinck@gmail.com>
StanFromIreland pushed a commit that referenced this pull request Jun 8, 2026
@miss-islington @czinck
[3.14] gh-101100: Fix Sphinx warnings in 'Buffer Object Structures' d…
6bd2e08 
…ocumentation (GH-151058)

(cherry picked from commit a187330)

Co-authored-by: Christian Zinck <christian.zinck@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland approved these changes

@ZeroIntensity ZeroIntensity Awaiting requested review from ZeroIntensity ZeroIntensity is a code owner

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

@hugovk hugovk Awaiting requested review from hugovk hugovk is a code owner

Assignees

No one assigned

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.

2 participants

@czinck @StanFromIreland