summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
Diffstat (limited to 'Doc')
-rw-r--r--Doc/api/api.tex8
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index 64feded..11ccffa 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -858,14 +858,16 @@ specify an arbitrary Python object for the ``value'' of the exception.
You need not increment its reference count.
\end{cfuncdesc}
-\begin{cfuncdesc}{PyObject*}{PyErr_Format}{PyObject *exception, const char *format, ...}
+\begin{cfuncdesc}{PyObject*}{PyErr_Format}{PyObject *exception,
+ const char *format, ...}
This function sets the error indicator using a printf-style format
string. The first argument specifies the exception type and the
second argument specifies the format string for the exception. Any
subsequent arguments are converted to output by the C library's
\cfunction{vsprintf()} function. The buffer used internally by
-PyErr_Format is 500 bytes long. The caller is responsible for
-guaranteeing that the formatted output does not overflow the buffer.
+\cfunction{PyErr_Format()} is 500 bytes long. The caller is
+responsible for guaranteeing that the formatted output does not
+overflow the buffer.
\end{cfuncdesc}
\begin{cfuncdesc}{void}{PyErr_SetNone}{PyObject *type}