summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-12-03 16:36:43 (GMT)
committerFred Drake <fdrake@acm.org>2001-12-03 16:36:43 (GMT)
commitf07125ee53efcb29c83c051d6efee7c04df69a16 (patch)
tree4c07bcb96195918826847ea875b2ef845ed0fd40
parentdbb53d99189075522eecc87723292c85aee15388 (diff)
downloadcpython-f07125ee53efcb29c83c051d6efee7c04df69a16.zip
cpython-f07125ee53efcb29c83c051d6efee7c04df69a16.tar.gz
cpython-f07125ee53efcb29c83c051d6efee7c04df69a16.tar.bz2
PyErr_Format() does not return a new reference; it always returns NULL.
This closes SF bug #488387.
-rw-r--r--Doc/api/exceptions.tex12
1 files changed, 5 insertions, 7 deletions
diff --git a/Doc/api/exceptions.tex b/Doc/api/exceptions.tex
index 355e6fb..997209d 100644
--- a/Doc/api/exceptions.tex
+++ b/Doc/api/exceptions.tex
@@ -121,11 +121,11 @@ for each thread.
\begin{cfuncdesc}{PyObject*}{PyErr_Format}{PyObject *exception,
const char *format, \moreargs}
- This function sets the error indicator. \var{exception} should be a
- Python exception (string or class, not an instance). \var{format}
- should be a string, containing format codes, similar to
- \cfunction{printf()}. The \code{width.precision} before a format
- code is parsed, but the width part is ignored.
+ This function sets the error indicator and returns \NULL..
+ \var{exception} should be a Python exception (string or class, not
+ an instance). \var{format} should be a string, containing format
+ codes, similar to \cfunction{printf()}. The \code{width.precision}
+ before a format code is parsed, but the width part is ignored.
\begin{tableii}{c|l}{character}{Character}{Meaning}
\lineii{c}{Character, as an \ctype{int} parameter}
@@ -137,8 +137,6 @@ for each thread.
An unrecognized format character causes all the rest of the format
string to be copied as-is to the result string, and any extra
arguments discarded.
-
- A new reference is returned, which is owned by the caller.
\end{cfuncdesc}
\begin{cfuncdesc}{void}{PyErr_SetNone}{PyObject *type}