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

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

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
* 1: No objects
* 2: All old objects
*/
if (result == NULL || generation == 1) {
Copy link
Contributor

Choose a reason for hiding this comment

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

As a procedural question, do we need to seek release manager permission for this on 3.13 following the release candidate?

Copy link
Member Author

Choose a reason for hiding this comment

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

No harm in letting @Yhg1s know now. He'll definitely need to know for the backport.

@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 and others added 2 commits August 23, 2024 17:03
Co-authored-by: Michael Droettboom <mdboom@gmail.com>
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.

None yet

2 participants