summaryrefslogtreecommitdiffstats
path: root/Python/sysmodule.c
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-06-20 21:36:19 (GMT)
committerFred Drake <fdrake@acm.org>2002-06-20 21:36:19 (GMT)
commitba3ff1ba7ba9b3920bafc1722c62b8abdb77b93c (patch)
treefb4673d5a6cdba21337a2f96e11e9640bca3fad0 /Python/sysmodule.c
parente36a8e8201fdacb04d75dce83662a735afe91588 (diff)
downloadcpython-ba3ff1ba7ba9b3920bafc1722c62b8abdb77b93c.zip
cpython-ba3ff1ba7ba9b3920bafc1722c62b8abdb77b93c.tar.gz
cpython-ba3ff1ba7ba9b3920bafc1722c62b8abdb77b93c.tar.bz2
Fix the docstring for sys.getrefcount().
Closes SF bug #571759.
Diffstat (limited to 'Python/sysmodule.c')
-rw-r--r--Python/sysmodule.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/Python/sysmodule.c b/Python/sysmodule.c
index 04c643f..ebf7f39 100644
--- a/Python/sysmodule.c
+++ b/Python/sysmodule.c
@@ -482,8 +482,9 @@ sys_gettotalrefcount(PyObject *self)
PyDoc_STRVAR(getrefcount_doc,
"getrefcount(object) -> integer\n\
\n\
-Return the current reference count for the object. This includes the\n\
-temporary reference in the argument list, so it is at least 2."
+Return the reference count of object. The count returned is generally\n\
+one higher than you might expect, because it includes the (temporary)\n\
+reference as an argument to getrefcount()."
);
#ifdef COUNT_ALLOCS