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.

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

gh-101100: Fix Sphinx warnings in c-api/structures.rst #113564

Merged
merged 5 commits into from
Jan 24, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Dec 29, 2023

Fix these two warnings:

Doc/c-api/structures.rst:519: WARNING: c:type reference target not found: PyTypeSlot
Doc/c-api/structures.rst:524: WARNING: c:type reference target not found: PyTypeSlot

They're typos, should be PyType_Slot. See PR #103511 where they were added (to 3.12, no backport needed for 3.11).

That leaves these two warnings in this file:

Doc/c-api/structures.rst:656: WARNING: c:identifier reference target not found: getter
Doc/c-api/structures.rst:660: WARNING: c:identifier reference target not found: setter

I'm not sure what to do with these, any ideas? (Added in PR #100054, also in 3.12.)


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

@hugovk
Copy link
Member Author

hugovk commented Jan 24, 2024

@encukou Any suggestion for the getter/setter warnings here?

@encukou
Copy link
Member

encukou commented Jan 24, 2024

They're defined a few lines below. (Definitely not the first place I looked!)

I hope you're OK with me pushing a fix-up directly to the PR.
I also found a nearby improvement to make: for struct fields, NULL works better than “omitted”.

@hugovk
Copy link
Member Author

hugovk commented Jan 24, 2024

I am, thank you!

@hugovk hugovk merged commit 51d9068 into python:main Jan 24, 2024
23 checks passed
@hugovk hugovk deleted the docs-fix-sphinx-warnings-c-api-structures branch January 24, 2024 13:40
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 24, 2024
…nGH-113564)

(cherry picked from commit 51d9068)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Jan 24, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Jan 24, 2024
hugovk added a commit that referenced this pull request Jan 24, 2024
…13564) (#114527)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
…n#113564)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
…n#113564)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants