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

[3.11] gh-98154: Clarify Usage of "Reference Count" In the Docs #107753

Merged

Conversation

ericsnowcurrently
Copy link
Member

@ericsnowcurrently ericsnowcurrently commented Aug 7, 2023

PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has.

This change updates the documentation to reflect that perspective.


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

PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts.  In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has.

This change updates the documentation to reflect that perspective.  It also updates the docs relative to immortal objects in a handful of places.
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Aug 7, 2023
@ericsnowcurrently ericsnowcurrently removed the needs backport to 3.10 only security fixes label Aug 7, 2023
@ericsnowcurrently ericsnowcurrently merged commit 951320e into python:3.11 Aug 7, 2023
@ericsnowcurrently ericsnowcurrently deleted the docs-refcounts-3.11 branch August 7, 2023 22:17
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