summaryrefslogtreecommitdiffstats
path: root/Python/sysmodule.c
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-06-20 21:35:02 (GMT)
committerFred Drake <fdrake@acm.org>2002-06-20 21:35:02 (GMT)
commited06e07dc93d237bdcb36bb708fab91a8c031c06 (patch)
treed589ebcfcc461ef1b091c6b5686d25b308407134 /Python/sysmodule.c
parent950fc70f7cbdbdb271f00afac0fc48e23bfc9d3d (diff)
downloadcpython-ed06e07dc93d237bdcb36bb708fab91a8c031c06.zip
cpython-ed06e07dc93d237bdcb36bb708fab91a8c031c06.tar.gz
cpython-ed06e07dc93d237bdcb36bb708fab91a8c031c06.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 581a19b..dbe73e7 100644
--- a/Python/sysmodule.c
+++ b/Python/sysmodule.c
@@ -466,8 +466,9 @@ sys_gettotalrefcount(PyObject *self)
static char 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
static PyObject *