diff Doc/api/api.tex @ 15236:f1ade8ab1869 legacy-trunk

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).
author Fred Drake <fdrake@acm.org>
date Sat, 14 Oct 2000 05:49:30 +0000
parents a13a2acbe214
children be42ce295edb 0da4ccc7e8cf
line wrap: on
line diff
--- a/Doc/api/api.tex	Sat Oct 14 05:47:17 2000 +0000
+++ b/Doc/api/api.tex	Sat Oct 14 05:49:30 2000 +0000
@@ -882,8 +882,8 @@
 
 \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.