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).

diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index d91f29b8fb02ca1565b778e9ac4df9a22ead445f..87ac55cacf08521c06fad1ec3d5c079ea9bdd3da 100644 (file)
--- 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.