summaryrefslogtreecommitdiffstats
path: root/Doc/library/gc.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2013-12-26 20:11:28 (GMT)
committerR David Murray <rdmurray@bitdance.com>2013-12-26 20:11:28 (GMT)
commit0e814634e5b279b3d8eb4987dc5039a0e8ec270e (patch)
tree60d775b28507b4d0ea3b48f9c5b7586b2022219f /Doc/library/gc.rst
parente190fac5f957c6da69fa7401a290291e89904879 (diff)
downloadcpython-0e814634e5b279b3d8eb4987dc5039a0e8ec270e.zip
cpython-0e814634e5b279b3d8eb4987dc5039a0e8ec270e.tar.gz
cpython-0e814634e5b279b3d8eb4987dc5039a0e8ec270e.tar.bz2
whatsnew for gc.get_stats, plus doc tweaks.
Clarified the "At the moment" wording, and added the get_stats entry in the module summary that Serhiy noted was missing at the end of issue 16351. Given that pydoc lists all the function docstrings, I'm not sure that module summary section is actually needed; but, it is probably better to address that when the module is converted to use Argument Clinic. In the meantime we should keep the list complete.
Diffstat (limited to 'Doc/library/gc.rst')
-rw-r--r--Doc/library/gc.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst
index 6b95dc5..8135542 100644
--- a/Doc/library/gc.rst
+++ b/Doc/library/gc.rst
@@ -69,9 +69,10 @@ The :mod:`gc` module provides the following functions:
.. function:: get_stats()
- Return a list of 3 per-generation dictionaries containing collection
- statistics since interpreter start. At this moment, each dictionary will
- contain the following items:
+ Return a list of three per-generation dictionaries containing collection
+ statistics since interpreter start. The number of keys may change
+ in the future, but currently each dictionary will contain the following
+ items:
* ``collections`` is the number of times this generation was collected;