From 311c580539328572045974bc50d9904a03a64e79 Mon Sep 17 00:00:00 2001 From: "Andrew M. Kuchling" Date: Sat, 10 May 2008 17:37:05 +0000 Subject: [PATCH] Document the 'line' argument --- Doc/library/warnings.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst index 87c4fd6c003..888cb84ef04 100644 --- a/Doc/library/warnings.rst +++ b/Doc/library/warnings.rst @@ -218,6 +218,9 @@ Available Functions resulting string to *file*, which defaults to ``sys.stderr``. You may replace this function with an alternative implementation by assigning to ``warnings.showwarning``. + *line* is a line of source code to be included in the warning + message; if *line* is not supplied, :func:`showwarning` will + try to read the line specified by *filename* and *lineno*. .. versionchanged:: 2.6 Added the *line* argument. Implementations that lack the new argument @@ -227,7 +230,9 @@ Available Functions .. function:: formatwarning(message, category, filename, lineno[, line]) Format a warning the standard way. This returns a string which may contain - embedded newlines and ends in a newline. + embedded newlines and ends in a newline. *line* is + a line of source code to be included in the warning message; if *line* is not supplied, + :func:`formatwarning` will try to read the line specified by *filename* and *lineno*. .. versionchanged:: 2.6 Added the *line* argument.