diff options
author | Guido van Rossum <guido@python.org> | 2001-02-28 23:34:21 (GMT) |
---|---|---|
committer | Guido van Rossum <guido@python.org> | 2001-02-28 23:34:21 (GMT) |
commit | 56ba72a5630071e4b4c355cbb4af86e189ed5ba3 (patch) | |
tree | 1ce1d6106f5a4b73150a6473018e3255f4777a1d /Doc/lib | |
parent | f1d7b41fa0d4e0b24755809a8fd9d34f5a851b57 (diff) | |
download | cpython-56ba72a5630071e4b4c355cbb4af86e189ed5ba3.zip cpython-56ba72a5630071e4b4c355cbb4af86e189ed5ba3.tar.gz cpython-56ba72a5630071e4b4c355cbb4af86e189ed5ba3.tar.bz2 |
Document warn_explicit().
Diffstat (limited to 'Doc/lib')
-rw-r--r-- | Doc/lib/libwarnings.tex | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Doc/lib/libwarnings.tex b/Doc/lib/libwarnings.tex index 051c79d..21d0bcf 100644 --- a/Doc/lib/libwarnings.tex +++ b/Doc/lib/libwarnings.tex @@ -161,6 +161,16 @@ rather than to the source of \function{deprecation()} itself (since the latter would defeat the purpose of the warning message). \end{funcdesc} +\begin{funcdesc}{warn_explicit}{message, category, filename, + lineno\optional{, module\optional{, registry}}} +This is a low-level interface to the functionality of +\function{warn()}, passing in explicitly the message, category, +filename and line number, and optionally the module name and the +registry (which should be the \code{__warningregistry__} dictionary of +the module). The module name defaults to the filename with \code{.py} +stripped; if no registry is passed, the warning is never suppressed. +\end{funcdesc} + \begin{funcdesc}{showwarning}{message, category, filename, lineno\optional{, file}} Write a warning to a file. The default implementation calls |