diff options
| author | Georg Brandl <georg@python.org> | 2009-09-16 15:58:14 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-09-16 15:58:14 (GMT) |
| commit | 7f01a13e7c47b6c4bcca601b597378408f3ceb2e (patch) | |
| tree | 938cccc27452ea421eb5b80521ddd8849661616b /Doc/library/warnings.rst | |
| parent | fe99105835b59e66ca1fd53ea3f8bcec3ec7cb3c (diff) | |
| download | cpython-7f01a13e7c47b6c4bcca601b597378408f3ceb2e.zip cpython-7f01a13e7c47b6c4bcca601b597378408f3ceb2e.tar.gz cpython-7f01a13e7c47b6c4bcca601b597378408f3ceb2e.tar.bz2 | |
Last round of adapting style of documenting argument default values.
Diffstat (limited to 'Doc/library/warnings.rst')
| -rw-r--r-- | Doc/library/warnings.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst index 260323e..36d47ad 100644 --- a/Doc/library/warnings.rst +++ b/Doc/library/warnings.rst @@ -234,7 +234,7 @@ Available Functions ------------------- -.. function:: warn(message[, category[, stacklevel]]) +.. function:: warn(message, category=None, stacklevel=1) Issue a warning, or maybe ignore it or raise an exception. The *category* argument, if given, must be a warning category class (see above); it defaults to @@ -253,7 +253,7 @@ Available Functions of the warning message). -.. function:: warn_explicit(message, category, filename, lineno[, module[, registry[, module_globals]]]) +.. function:: warn_explicit(message, category, filename, lineno, module=None, registry=None, module_globals=None) This is a low-level interface to the functionality of :func:`warn`, passing in explicitly the message, category, filename and line number, and optionally the @@ -270,7 +270,7 @@ Available Functions sources). -.. function:: showwarning(message, category, filename, lineno[, file[, line]]) +.. function:: showwarning(message, category, filename, lineno, file=None, line=None) Write a warning to a file. The default implementation calls ``formatwarning(message, category, filename, lineno, line)`` and writes the @@ -282,7 +282,7 @@ Available Functions try to read the line specified by *filename* and *lineno*. -.. function:: formatwarning(message, category, filename, lineno[, line]) +.. function:: formatwarning(message, category, filename, lineno, line=None) Format a warning the standard way. This returns a string which may contain embedded newlines and ends in a newline. *line* is a line of source code to @@ -291,7 +291,7 @@ Available Functions *lineno*. -.. function:: filterwarnings(action[, message[, category[, module[, lineno[, append]]]]]) +.. function:: filterwarnings(action, message='', category=Warning, module='', lineno=0, append=False) Insert an entry into the list of :ref:`warnings filter specifications <warning-filter>`. The entry is inserted at the front by default; if @@ -303,7 +303,7 @@ Available Functions everything. -.. function:: simplefilter(action[, category[, lineno[, append]]]) +.. function:: simplefilter(action, category=Warning, lineno=0, append=False) Insert a simple entry into the list of :ref:`warnings filter specifications <warning-filter>`. The meaning of the function parameters is as for @@ -322,7 +322,7 @@ Available Functions Available Context Managers -------------------------- -.. class:: catch_warnings([\*, record=False, module=None]) +.. class:: catch_warnings(\*, record=False, module=None) A context manager that copies and, upon exit, restores the warnings filter and the :func:`showwarning` function. |