gh-136209: Add .. c:var:: declarations for C exception types by encukou · Pull Request #136210 · python/cpython · GitHub | Latest TMZ Celebrity News & Gossip | Watch TMZ Live
Skip to content

gh-136209: Add .. c:var:: declarations for C exception types #136210

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

gh-136209: Add .. c:var:: declarations for C exception types #136210

wants to merge 4 commits into from
+242 −332

Conversation

encukou
Copy link
Member

@encukou encukou commented Jul 2, 2025 •
edited by github-actions bot
Loading

  • Add .. c:var:: declarations for C exception types. (This needs the type, and adds stable ABI declarations.)
  • Convert to list-table to avoid overlong lines
  • Merge the 3 tables -- these objects aren't very distinct
  • Remove the note about what's a base class. (This wasn't kept to date, and it isn't very useful info. Exceptions can grow subclasses in future Python versions anyway.)
  • Name the notes for more clarity
  • Remove properly documented names from nitpick_ignore

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

@encukou encukou requested review from AA-Turner and hugovk as code owners July 2, 2025 15:40
@encukou encukou added the docs Documentation in the Doc dir label Jul 2, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jul 2, 2025
@bedevere-app bedevere-app bot mentioned this pull request Jul 2, 2025
Open
vstinner
vstinner approved these changes Jul 3, 2025
View reviewed changes
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Doc/c-api/exceptions.rst
.. [3]
This is a base class for other standard warning categories.
.. versionchanged:: 3.3
These aliases used to be separate exception types.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
These aliases used to be separate exception types.
These aliases to :c:data:`PyExc_OSError` used to be separate exception types.

@serhiy-storchaka
Copy link
Member

I tried to do this before, but gave up when I saw that it was impossible to get rid of PyObject * until we can use :no-typesetting: in Sphinx 7.2. And now it generates also recurring "Part of the Stable ABI" which increases the table height.

serhiy-storchaka
serhiy-storchaka reviewed Jul 3, 2025
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to add space between three tables? Each table has certain order. When they are merged, there is no order.

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

@serhiy-storchaka serhiy-storchaka serhiy-storchaka left review comments

@vstinner vstinner vstinner approved these changes

@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
awaiting merge docs Documentation in the Doc dir skip news
Projects
Docs PRs
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@encukou @serhiy-storchaka @vstinner

TMZ Celebrity News – Breaking Stories, Videos & Gossip

Looking for the latest TMZ celebrity news? You've come to the right place. From shocking Hollywood scandals to exclusive videos, TMZ delivers it all in real time.

Whether it’s a red carpet slip-up, a viral paparazzi moment, or a legal drama involving your favorite stars, TMZ news is always first to break the story. Stay in the loop with daily updates, insider tips, and jaw-dropping photos.

🎥 Watch TMZ Live

TMZ Live brings you daily celebrity news and interviews straight from the TMZ newsroom. Don’t miss a beat—watch now and see what’s trending in Hollywood.