]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Document PyErr_WarnExplicit().
authorGuido van Rossum <guido@python.org>
Wed, 28 Feb 2001 23:46:44 +0000 (23:46 +0000)
committerGuido van Rossum <guido@python.org>
Wed, 28 Feb 2001 23:46:44 +0000 (23:46 +0000)
Doc/api/api.tex

index 7cda0d5b658c43e3190f55e7c500604df95f026b..7a116609fd638aad09508e79242bd99bdb5d8cd2 100644 (file)
@@ -980,6 +980,15 @@ For information about warning control, see the documentation for the
 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