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.

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

Update Refcount-related Docs #98154

Closed
ericsnowcurrently opened this issue Oct 10, 2022 · 0 comments
Closed

Update Refcount-related Docs #98154

ericsnowcurrently opened this issue Oct 10, 2022 · 0 comments
Labels
3.10 only security fixes 3.11 only security fixes 3.12 bugs and security fixes 3.13 bugs and security fixes docs Documentation in the Doc dir topic-C-API

Comments

@ericsnowcurrently
Copy link
Member

ericsnowcurrently commented Oct 10, 2022 •
edited by bedevere-bot
Loading

Documentation

PEP 683 includes some docs changes that should help narrow expectations about refcount semantics. Those changes shouldn't need to wait for the PEP.

I'd be interested in backporting these changes as far back as possible.

Linked PRs
@ericsnowcurrently ericsnowcurrently added the docs Documentation in the Doc dir label Oct 10, 2022
@ericsnowcurrently ericsnowcurrently mentioned this issue Nov 8, 2022
Open
@ericsnowcurrently ericsnowcurrently added interpreter-core (Objects, Python, Grammar, and Parser dirs) 3.11 only security fixes topic-C-API 3.12 bugs and security fixes 3.13 bugs and security fixes 3.10 only security fixes and removed interpreter-core (Objects, Python, Grammar, and Parser dirs) labels Jul 26, 2023
@bedevere-bot bedevere-bot mentioned this issue Aug 1, 2023
Merged
ericsnowcurrently added a commit that referenced this issue Aug 7, 2023
@ericsnowcurrently
gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552)
5dc825d 
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 mentioned this issue Aug 7, 2023
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 7, 2023
@ericsnowcurrently @miss-islington
pythongh-98154: Clarify Usage of "Reference Count" In the Docs (pytho…
0c5e7fe 
…ngh-107552)

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.
(cherry picked from commit 5dc825d)

Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
This was referenced Aug 7, 2023
Merged
Merged
ericsnowcurrently added a commit that referenced this issue Aug 7, 2023
@ericsnowcurrently
[3.11] gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-1…
951320e 
…07753)

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.
Yhg1s pushed a commit that referenced this issue Aug 8, 2023
@miss-islington @ericsnowcurrently
[3.12] gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-1…
aa2ecef 
…07552) (#107752)

* gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552)

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.
(cherry picked from commit 5dc825d)

Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>

* Fix a typo.

---------

Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
@github-project-automation github-project-automation bot moved this from Todo to Done in Fancy CPython Board Aug 8, 2023
pablogsal pushed a commit that referenced this issue Aug 11, 2023
@ericsnowcurrently
[3.10] gh-98154: Clarify Usage of "Reference Count" In the Docs (#107754
917439d 
)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3.10 only security fixes 3.11 only security fixes 3.12 bugs and security fixes 3.13 bugs and security fixes docs Documentation in the Doc dir topic-C-API
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ericsnowcurrently