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-101100: Fix Sphinx warnings in `c-api/structures.rst` by hugovk · Pull Request #113564 · python/cpython

Conversation

@hugovk

@hugovk hugovk commented Dec 29, 2023 •
edited
Loading

Uh oh!

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

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.)

  • Issue: Fix all Sphinx reference warnings in the documentation #101100

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@hugovk
Fix Sphinx warnings in c-api/structures.rst
0187af8
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting core review labels Dec 29, 2023
@bedevere-app bedevere-app Bot mentioned this pull request Dec 29, 2023
Fix all Sphinx reference warnings in the documentation #101100
Closed
@hugovk hugovk added the needs backport to 3.12 only security fixes label Dec 29, 2023
@hugovk

hugovk commented Jan 24, 2024

Copy link
Copy Markdown
Member Author

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
encukou added 2 commits January 24, 2024 11:15
@encukou
Use the proper directives for getter and setter
3405b9b
@encukou
Use NULL rather than "omitted" for a C field
aefc58c
@encukou

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”.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
hugovk added 2 commits January 24, 2024 13:02
@hugovk
All warnings fixedd in Doc/c-api/structures.rst
c8725cf
@hugovk
Hyphenate read-only
fbba9a4
@hugovk

hugovk commented Jan 24, 2024

Copy link
Copy Markdown
Member Author

I am, thank you!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@hugovk
hugovk merged commit 51d9068 into python:main Jan 24, 2024
@hugovk
hugovk deleted the docs-fix-sphinx-warnings-c-api-structures branch January 24, 2024 13:40
@miss-islington-app

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.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting core review label Jan 24, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 24, 2024
@hugovk @encukou @miss-islington
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 <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Petr Viktorin <[email protected]>
@bedevere-app

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app 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
@miss-islington @hugovk @encukou
[3.12] gh-101100: Fix Sphinx warnings in c-api/structures.rst (GH-1…
3a588d0 
…13564) (#114527)

Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Petr Viktorin <[email protected]>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@hugovk @encukou @aisk
pythongh-101100: Fix Sphinx warnings in c-api/structures.rst (pytho…
08695d8 
…n#113564)

Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Petr Viktorin <[email protected]>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@hugovk @encukou @Glyphack
pythongh-101100: Fix Sphinx warnings in c-api/structures.rst (pytho…
ee9d0b5 
…n#113564)

Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Petr Viktorin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

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

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.

Uh oh!

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

2 participants

@hugovk @encukou
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.