FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix Sphinx warnings in `c-api/structures.rst` by hugovk · Pull Request #113564 · python/cpython · GitHub

/ cpython Public

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

Merged
hugovk merged 5 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-c-api-structures
Jan 24, 2024
ConversationCommits (5)ChecksFiles changed
Merged

gh-101100: Fix Sphinx warnings in c-api/structures.rst#113564
hugovk merged 5 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-c-api-structures

Conversation

hugovk commented Dec 29, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

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/

bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting core review labels Dec 29, 2023
bedevere-app Bot mentioned this pull request Dec 29, 2023
Closed
hugovk added the needs backport to 3.12 only security fixes label Dec 29, 2023

hugovk commented Jan 24, 2024

Copy link
Copy Markdown
Member Author

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

encukou commented Jan 24, 2024

Copy link
Copy Markdown
Member

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 commented Jan 24, 2024

Copy link
Copy Markdown
Member Author

I am, thank you!

hugovk merged commit 51d9068 into python:main Jan 24, 2024
hugovk deleted the docs-fix-sphinx-warnings-c-api-structures branch January 24, 2024 13:40

miss-islington-app Bot commented Jan 24, 2024

Copy link
Copy Markdown

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
pythongh-101100: Fix Sphinx warnings in c-api/structures.rst (pytho…
74b344b 
…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 Bot commented Jan 24, 2024

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Jan 24, 2024
hugovk added a commit that referenced this pull request Jan 24, 2024
[3.12] gh-101100: Fix Sphinx warnings in c-api/structures.rst (GH-1…
3a588d0 
…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
pythongh-101100: Fix Sphinx warnings in c-api/structures.rst (pytho…
08695d8 
…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
pythongh-101100: Fix Sphinx warnings in c-api/structures.rst (pytho…
ee9d0b5 
…n#113564)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

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.

2 participants

Back | FazBrowse Home | New Git URL