summaryrefslogtreecommitdiffstats
path: root/Doc/api/api.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-04-10 18:50:14 (GMT)
committerFred Drake <fdrake@acm.org>2000-04-10 18:50:14 (GMT)
commit73577701538b65ff9c468219a46a90d6990ae683 (patch)
treefdea5dbf3ecac13394e05176371f3527c2c4f657 /Doc/api/api.tex
parent37f41565a850e0e9a15eb99dab1f2ac3f153b803 (diff)
downloadcpython-73577701538b65ff9c468219a46a90d6990ae683.zip
cpython-73577701538b65ff9c468219a46a90d6990ae683.tar.gz
cpython-73577701538b65ff9c468219a46a90d6990ae683.tar.bz2
Yet another markup nit: functions that are part of the Python/C API
are still C functions, and should be marked.
Diffstat (limited to 'Doc/api/api.tex')
-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}