Document the 'line' argument
This commit is contained in:
parent
5217d5d678
commit
311c580539
|
@ -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.
|
||||
|
|
Loading…
Reference in New Issue