From: Fred Drake <fdrake@acm.org>
Date: Sat, 14 Oct 2000 05:49:30 +0000 (+0000)
Subject: For PyErr_Format(), note that the exception parameter can be a string or
X-Git-Tag: v2.0~19
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=89fb03524842f88b1f1301148483b5050bbc9826;p=python

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 d91f29b8fb..87ac55cacf 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.