summaryrefslogtreecommitdiffstats
path: root/Doc/api
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-04-10 18:29:21 (GMT)
committerFred Drake <fdrake@acm.org>2000-04-10 18:29:21 (GMT)
commit8394595f3b25f3b00382ebdd78bdb4cfb7f69e6b (patch)
tree0a64424adea12b612ad22af47b975b532ff83d93 /Doc/api
parentc2578c5bb61915f7e2d292704ebe2a6176a6cb26 (diff)
downloadcpython-8394595f3b25f3b00382ebdd78bdb4cfb7f69e6b.zip
cpython-8394595f3b25f3b00382ebdd78bdb4cfb7f69e6b.tar.gz
cpython-8394595f3b25f3b00382ebdd78bdb4cfb7f69e6b.tar.bz2
Add to the comment a description of the "null" value for returned
PyObject* values.
Diffstat (limited to 'Doc/api')
-rw-r--r--Doc/api/refcounts.dat5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/api/refcounts.dat b/Doc/api/refcounts.dat
index 8da1bf2..0e9374e 100644
--- a/Doc/api/refcounts.dat
+++ b/Doc/api/refcounts.dat
@@ -16,7 +16,10 @@
# Refcount behavior is given for all PyObject* types: 0 (no change), +1
# (increment) and -1 (decrement). A blank refcount field indicates the
# parameter or function value is not a PyObject* and is therefore not
-# subject to reference counting.
+# subject to reference counting. A special case for the value "null"
+# (without quotes) is used for functions which return a PyObject* type but
+# always return NULL. This is used by some of the PyErr_*() functions, in
+# particular.
# The parameter names are as they appear in the API manual, not the source
# code.