Skip to content

Commit 730d450

Browse files
authored
gh-112502: Docs: Improve docs for gc.collect method (#112562)
* Docs: Improve docs for gc.collect method * Update gc.rst
1 parent 482b0ee commit 730d450

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Doc/library/gc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ The :mod:`gc` module provides the following functions:
4242

4343
With no arguments, run a full collection. The optional argument *generation*
4444
may be an integer specifying which generation to collect (from 0 to 2). A
45-
:exc:`ValueError` is raised if the generation number is invalid. The number of
46-
unreachable objects found is returned.
45+
:exc:`ValueError` is raised if the generation number is invalid. The sum of
46+
collected objects and uncollectable objects is returned.
4747

4848
The free lists maintained for a number of built-in types are cleared
4949
whenever a full collection or collection of the highest generation (2)

0 commit comments

Comments
 (0)