From 8394595f3b25f3b00382ebdd78bdb4cfb7f69e6b Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Mon, 10 Apr 2000 18:29:21 +0000 Subject: [PATCH] Add to the comment a description of the "null" value for returned PyObject* values. --- Doc/api/refcounts.dat | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Doc/api/refcounts.dat b/Doc/api/refcounts.dat index 8da1bf2ebe4..0e9374ef01e 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.