From: Alperen Serkan Aksöz <61659936+Sekomer@users.noreply.github.com>
Date: Thu, 30 Nov 2023 21:04:00 +0000 (+0300)
Subject: gh-112502: Docs: Improve docs for gc.collect method (#112562)
X-Git-Tag: v3.13.0a3~587
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=730d450d4334978f07e3cf39e1b320f2954e7963;p=thirdparty%2FPython%2Fcpython.git

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

* Docs: Improve docs for gc.collect method

* Update gc.rst
---

diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst
index 331c071cda76..82277aa52aee 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)