From: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Date: Fri, 29 Jul 2005 11:52:19 +0000 (+0000)
Subject: Documentation added about changes in 2.4 to basicConfig(), including documentation... 
X-Git-Tag: v2.5a0~1561
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c320c22f79b8f5af7d3fe4e05b1ea6eaf15a4c8b;p=python

Documentation added about changes in 2.4 to basicConfig(), including documentation of the keyword arguments. A version change note was also added to the basic example.
---

diff --git a/Doc/lib/liblogging.tex b/Doc/lib/liblogging.tex
index cca83ca501..3f24092cbf 100644
--- a/Doc/lib/liblogging.tex
+++ b/Doc/lib/liblogging.tex
@@ -258,13 +258,32 @@ defined by \var{attrdict}. This function is useful for taking a pickled
 it as a \class{LogRecord} instance at the receiving end.
 \end{funcdesc}
 
-\begin{funcdesc}{basicConfig}{}
+\begin{funcdesc}{basicConfig}{\optional{**kwargs}}
 Does basic configuration for the logging system by creating a
 \class{StreamHandler} with a default \class{Formatter} and adding it to
 the root logger. The functions \function{debug()}, \function{info()},
 \function{warning()}, \function{error()} and \function{critical()} will call
 \function{basicConfig()} automatically if no handlers are defined for the
 root logger.
+
+\versionchanged[Formerly, \function{basicConfig} did not take any keyword
+arguments]{2.4}
+
+The following keyword arguments are supported.
+
+\begin{tableii}{l|l}{code}{Format}{Description}
+\lineii{filename}{Specifies that a FileHandler be created, using the
+specified filename, rather than a StreamHandler.}
+\lineii{filemode}{Specifies the mode to open the file, if filename is
+specified (if filemode is unspecified, it defaults to 'a').}
+\lineii{format}{Use the specified format string for the handler.}
+\lineii{datefmt}{Use the specified date/time format.}
+\lineii{level}{Set the root logger level to the specified level.}
+\lineii{stream}{Use the specified stream to initialize the StreamHandler.
+Note that this argument is incompatible with 'filename' - if both
+are present, 'stream' is ignored.}
+\end{tableii}
+
 \end{funcdesc}
 
 \begin{funcdesc}{shutdown}{}
@@ -415,6 +434,9 @@ specialized \class{LogRecord} instances.
 
 \subsection{Basic example \label{minimal-example}}
 
+\versionchanged[formerly \function{basicConfig} did not take any keyword
+arguments]{2.4}
+
 The \module{logging} package provides a lot of flexibility, and its
 configuration can appear daunting.  This section demonstrates that simple
 use of the logging package is possible.