gh-112502: Docs: Improve docs for gc.collect method #112562
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bedevere-app
bot
added
awaiting review
docs
AlexWaygood
changed the title
pablogsal
approved these changes
Nov 30, 2023
|
Thanks for your contribution @sekomer ! |
|
My pleasure :) @pablogsal |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refined the documentation for the
gc.collect()function to provide a more accurate description of its behavior. Specifically, updated the documentation to reflect that the function now returns the sum of the number of objects collected and the number of uncollectable objects. This adjustment aligns the documentation with the existing implementation in gcmodule.c, where the stats returned bygc.collect()include both collected and uncollectable objects.No changes were made to the gcmodule.c code; this modification focuses solely on improving the clarity of the documentation.