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

GH-117759: Document incremental GC #123266

Merged
merged 4 commits into from
Aug 27, 2024

Conversation

markshannon
Copy link
Member

@markshannon markshannon commented Aug 23, 2024

This PR updates the docs for what's new in 3.13 and updates the docs for the GC module.

It also includes a small behavioral change to gc.get_objects() to make it more consistent with the result of the gc module API and consistent with incremental collection:

gc.get_objects(1) now returns no objects.
gc_get_objects(2) now returns all objects in the old generation.


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

Doc/library/gc.rst Outdated Show resolved Hide resolved
Doc/library/gc.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.13.rst Outdated Show resolved Hide resolved
Python/gc.c Show resolved Hide resolved
@bedevere-app
Copy link

bedevere-app bot commented Aug 23, 2024

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

@markshannon
Copy link
Member Author

I have made the requested changes; please review again

@bedevere-app
Copy link

bedevere-app bot commented Aug 27, 2024

Thanks for making the requested changes!

@mdboom: please review the changes made to this pull request.

@bedevere-app bedevere-app bot requested a review from mdboom August 27, 2024 09:37
@markshannon markshannon merged commit f49a916 into python:main Aug 27, 2024
38 of 42 checks passed
@miss-islington-app
Copy link

Thanks @markshannon for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 27, 2024
* Update what's new

* Update gc module docs and fix inconsistency in gc.get_objects
(cherry picked from commit f49a916)

Co-authored-by: Mark Shannon <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Aug 27, 2024

GH-123395 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Aug 27, 2024
Yhg1s pushed a commit that referenced this pull request Sep 2, 2024
GH-117759: Document incremental GC (GH-123266)

* Update what's new

* Update gc module docs and fix inconsistency in gc.get_objects
(cherry picked from commit f49a916)

Co-authored-by: Mark Shannon <[email protected]>
Yhg1s added a commit to Yhg1s/cpython that referenced this pull request Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants