summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Martelli <aleaxit@gmail.com>2003-11-09 16:38:39 (GMT)
committerAlex Martelli <aleaxit@gmail.com>2003-11-09 16:38:39 (GMT)
commit721b776175da4d5af1982deb99881eaabd07dba5 (patch)
tree0f4fb482a2b48d0ed53bf5698c892f97ab5bf3ce
parentc516b0e47cde4239db8e0cf91899d0f3c9b39665 (diff)
downloadcpython-721b776175da4d5af1982deb99881eaabd07dba5.zip
cpython-721b776175da4d5af1982deb99881eaabd07dba5.tar.gz
cpython-721b776175da4d5af1982deb99881eaabd07dba5.tar.bz2
fixed buggy comment as per SF bug #827856
(same as commit of Sun Nov 2 to the release23-maint branch)
-rw-r--r--Include/object.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/Include/object.h b/Include/object.h
index 93249bd..f6135ee 100644
--- a/Include/object.h
+++ b/Include/object.h
@@ -698,22 +698,22 @@ It takes a while to get used to the proper usage of reference counts.
Functions that create an object set the reference count to 1; such new
objects must be stored somewhere or destroyed again with Py_DECREF().
-Functions that 'store' objects such as PyTuple_SetItem() and
-PyDict_SetItemString()
+Some functions that 'store' objects, such as PyTuple_SetItem() and
+PyList_SetItem(),
don't increment the reference count of the object, since the most
frequent use is to store a fresh object. Functions that 'retrieve'
-objects such as PyTuple_GetItem() and PyDict_GetItemString() also
+objects, such as PyTuple_GetItem() and PyDict_GetItemString(), also
don't increment
the reference count, since most frequently the object is only looked at
quickly. Thus, to retrieve an object and store it again, the caller
must call Py_INCREF() explicitly.
-NOTE: functions that 'consume' a reference count like
-PyList_SetItemString() even consume the reference if the object wasn't
-stored, to simplify error handling.
+NOTE: functions that 'consume' a reference count, like
+PyList_SetItem(), consume the reference even if the object wasn't
+successfully stored, to simplify error handling.
It seems attractive to make other functions that take an object as
-argument consume a reference count; however this may quickly get
+argument consume a reference count; however, this may quickly get
confusing (even the current practice is already confusing). Consider
it carefully, it may save lots of calls to Py_INCREF() and Py_DECREF() at
times.