Skip to content

gh-101100: fix sphinx warnings in PyTypeObject documentation#151058

Open
czinck wants to merge 1 commit into
python:mainfrom
czinck:gh-101100-typeobj-warnings
Open

gh-101100: fix sphinx warnings in PyTypeObject documentation#151058
czinck wants to merge 1 commit into
python:mainfrom
czinck:gh-101100-typeobj-warnings

Conversation

@czinck
Copy link
Copy Markdown

@czinck czinck commented Jun 7, 2026

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

All commit authors signed the Contributor License Agreement.

CLA signed

@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

Documentation build overview

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

  🔍 Preview build  

1 file changed
± c-api/typeobj.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant