summaryrefslogtreecommitdiffstats
path: root/Doc/api
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-10-14 05:49:30 (GMT)
committerFred Drake <fdrake@acm.org>2000-10-14 05:49:30 (GMT)
commit89fb03524842f88b1f1301148483b5050bbc9826 (patch)
treed897c02b7e9b0a0f66aba81b27c7df218bdcb5f3 /Doc/api
parent3c8c2f9b77b9986b0cbc49c85b05627f68a5fce0 (diff)
downloadcpython-89fb03524842f88b1f1301148483b5050bbc9826.zip
cpython-89fb03524842f88b1f1301148483b5050bbc9826.tar.gz
cpython-89fb03524842f88b1f1301148483b5050bbc9826.tar.bz2
For PyErr_Format(), note that the exception parameter can be a string or
class, but not an instance (since an instance will be created using the formatted message string as the constructor parameter).
Diffstat (limited to 'Doc/api')
-rw-r--r--Doc/api/api.tex4
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index d91f29b..87ac55c 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -882,8 +882,8 @@ You need not increment its reference count.
\begin{cfuncdesc}{PyObject*}{PyErr_Format}{PyObject *exception,
const char *format, \moreargs}
-This function sets the error indicator.
-\var{exception} should be a Python object.
+This function sets the error indicator. \var{exception} should be a
+Python exception (string or class, not an instance).
\var{fmt} 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.