summaryrefslogtreecommitdiffstats
path: root/Doc/api
diff options
context:
space:
mode:
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.