diff options
| author | Alperen Serkan Aksöz <61659936+Sekomer@users.noreply.github.com> | 2023-11-30 21:04:00 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-30 21:04:00 (GMT) |
| commit | 730d450d4334978f07e3cf39e1b320f2954e7963 (patch) | |
| tree | 4b80f5d0c9d6d214a61ee470dc37f3a35c547038 | |
| parent | 482b0ee8f6cdecd96c246c8bcbda93292f4d08cc (diff) | |
| download | cpython-730d450d4334978f07e3cf39e1b320f2954e7963.zip cpython-730d450d4334978f07e3cf39e1b320f2954e7963.tar.gz cpython-730d450d4334978f07e3cf39e1b320f2954e7963.tar.bz2 | |
gh-112502: Docs: Improve docs for gc.collect method (#112562)
* Docs: Improve docs for gc.collect method
* Update gc.rst
| -rw-r--r-- | Doc/library/gc.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst index 331c071..82277aa 100644 --- a/Doc/library/gc.rst +++ b/Doc/library/gc.rst @@ -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) |