languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-07-19 19:54:39 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

gh-112502: Docs: Improve docs for gc.collect method (#112562)

Browse source 
* Docs: Improve docs for gc.collect method

* Update gc.rst
This commit is contained in:
Alperen Serkan Aksöz 2023-12-01 00:04:00 +03:00 committed by GitHub
parent 482b0ee8f6
commit 730d450d43
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Doc/library/gc.rst
View file

@ -42,8 +42,8 @@ The :mod:`gc` module provides the following functions:
With no arguments, run a full collection. The optional argument *generation*
may be an integer specifying which generation to collect (from 0 to 2). A
:exc:`ValueError` is raised if the generation number is invalid. The number of
unreachable objects found is returned.
:exc:`ValueError` is raised if the generation number is invalid. The sum of
collected objects and uncollectable objects is returned.
The free lists maintained for a number of built-in types are cleared
whenever a full collection or collection of the highest generation (2)