[Python-checkins] r52101 - python/trunk/Doc/lib/liblogging.tex

[vinay.sajip]

Author: vinay.sajip
Date: Tue Oct  3 20:20:26 2006
New Revision: 52101

Modified:
   python/trunk/Doc/lib/liblogging.tex
Log:
Documentation clarified to mention optional parameters.

Modified: python/trunk/Doc/lib/liblogging.tex
==============================================================================
--- python/trunk/Doc/lib/liblogging.tex	(original)
+++ python/trunk/Doc/lib/liblogging.tex	Tue Oct  3 20:20:26 2006
@@ -528,8 +528,8 @@
 \method{filter()}.
 \end{methoddesc}
 
-\begin{methoddesc}{makeRecord}{name, lvl, fn, lno, msg, args, exc_info,
-                               func, extra}
+\begin{methoddesc}{makeRecord}{name, lvl, fn, lno, msg, args, exc_info
+                               \optional{, func, extra}}
 This is a factory method which can be overridden in subclasses to create
 specialized \class{LogRecord} instances.
 \versionchanged[\var{func} and \var{extra} were added]{2.5}
@@ -1479,7 +1479,7 @@
 information to be logged.
 
 \begin{classdesc}{LogRecord}{name, lvl, pathname, lineno, msg, args,
-                             exc_info, func}
+                             exc_info \optional{, func}}
 Returns an instance of \class{LogRecord} initialized with interesting
 information. The \var{name} is the logger name; \var{lvl} is the
 numeric level; \var{pathname} is the absolute pathname of the source
@@ -1490,7 +1490,7 @@
 \var{exc_info} is the exception tuple obtained by calling
 \function{sys.exc_info() }(or \constant{None}, if no exception information
 is available). The \var{func} is the name of the function from which the
-logging call was made.
+logging call was made. If not specified, it defaults to \var{None}.
 \versionchanged[\var{func} was added]{2.5}
 \end{classdesc}