From 98605b54b4d35301e6a29eccac97592dd624528d Mon Sep 17 00:00:00 2001
From: Jeremy Hylton <jeremy@alum.mit.edu>
Date: Mon, 10 Apr 2000 18:40:57 +0000
Subject: document PyErr_Format

---
 Doc/api/api.tex       | 11 +++++++++++
 Doc/api/refcounts.dat |  5 +++++
 2 files changed, 16 insertions(+)

diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index d9e7fea..6b4786c 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -858,6 +858,17 @@ 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, ...}
+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.
+The return value is always \NULL{}.
+\end{cfuncdesc}
+
 \begin{cfuncdesc}{void}{PyErr_SetNone}{PyObject *type}
 This is a shorthand for \samp{PyErr_SetObject(\var{type}, Py_None)}.
 \end{cfuncdesc}
diff --git a/Doc/api/refcounts.dat b/Doc/api/refcounts.dat
index 0e9374e..6c2c99d 100644
--- a/Doc/api/refcounts.dat
+++ b/Doc/api/refcounts.dat
@@ -194,6 +194,11 @@ PyErr_SetString:void:::
 PyErr_SetString:PyObject*:type:+1:
 PyErr_SetString:char*:message::
 
+PyErr_Format:PyObject*::null:
+PyErr_Format:PyObject*:exception:+1:
+PyErr_Format:char*:format::
+PyErr_Format::...::
+
 PyEval_AcquireLock:void:::
 
 PyEval_AcquireThread:void:::
-- 
cgit v0.12

