diff Doc/api/api.tex @ 16872:5280e8439d55 legacy-trunk

Document PyErr_WarnExplicit().
author Guido van Rossum <guido@python.org>
date Wed, 28 Feb 2001 23:46:44 +0000
parents 068cb8494b7b
children 797ebb7033d7
line wrap: on
line diff
--- a/Doc/api/api.tex	Wed Feb 28 23:44:45 2001 +0000
+++ b/Doc/api/api.tex	Wed Feb 28 23:46:44 2001 +0000
@@ -980,6 +980,15 @@
 line documentation.  There is no C API for warning control.
 \end{cfuncdesc}
 
+\begin{cfuncdesc}{int}{PyErr_WarnExplicit}{PyObject *category, char *message,
+char *filename, int lineno, char *module, PyObject *registry}
+Issue a warning message with explicit control over all warning
+attributes.  This is a straightforward wrapper around the Python
+function \function{warnings.warn_explicit()}, see there for more
+information.  The \var{module} and \var{registry} arguments may be
+set to \code{NULL} to get the default effect described there.
+\end{cfuncdesc}
+
 \begin{cfuncdesc}{int}{PyErr_CheckSignals}{}
 This function interacts with Python's signal handling.  It checks
 whether a signal has been sent to the processes and if so, invokes the