Skip to content

Docs: Fix and improve the PyUnstable_Object_EnableDeferredRefcount documentation #135323

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 2 commits into
base: main
Choose a base branch
from
Open

Docs: Fix and improve the PyUnstable_Object_EnableDeferredRefcount documentation #135323

wants to merge 2 commits into from
+7 −5

Conversation

ZeroIntensity
Copy link
Member

@ZeroIntensity ZeroIntensity commented Jun 10, 2025 •
edited
Loading

  1. Clarify that the object isn't immediately deallocated when the interpreter is done with it.
  2. Fix the documented return value; it's documented as returning 1 when DRC is already enabled, but it actually returns 0.
  3. Mention the tp_new slot, where it should generally be used.

📚 Documentation preview 📚: https://cpython-previews--135323.org.readthedocs.build/en/135323/c-api/object.html#c.PyUnstable_Object_EnableDeferredRefcount

@ZeroIntensity ZeroIntensity requested a review from encukou June 10, 2025 01:20
@ZeroIntensity ZeroIntensity added docs Documentation in the Doc dir skip issue labels Jun 10, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jun 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@encukou encukou Awaiting requested review from encukou

Assignees
No one assigned
Labels
awaiting review docs Documentation in the Doc dir needs backport to 3.14 bugs and security fixes skip issue skip news topic-C-API
Projects
Docs PRs
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ZeroIntensity