[Python-checkins] r53296 - python/branches/release25-maint/Doc/lib/liblogging.tex

[vinay.sajip]

Author: vinay.sajip
Date: Mon Jan  8 10:36:17 2007
New Revision: 53296

Modified:
   python/branches/release25-maint/Doc/lib/liblogging.tex
Log:
Added relativeCreated to Formatter doc (has been in the system for a long time - was unaccountably left out of the docs and not noticed until now).
Documentation clarified to mention optional parameters.
Documentation omitted the additional parameter to LogRecord.__init__ which was added in 2.5. (See SF #1569622).



Modified: python/branches/release25-maint/Doc/lib/liblogging.tex
==============================================================================
--- python/branches/release25-maint/Doc/lib/liblogging.tex	(original)
+++ python/branches/release25-maint/Doc/lib/liblogging.tex	Mon Jan  8 10:36:17 2007
@@ -530,8 +530,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}
@@ -1399,6 +1399,9 @@
                         (if available).}
 \lineii{\%(created)f}  {Time when the \class{LogRecord} was created (as
                         returned by \function{time.time()}).}
+\lineii{\%(relativeCreated)d}  {Time in milliseconds when the LogRecord was
+                        created, relative to the time the logging module was
+                        loaded.}
 \lineii{\%(asctime)s}  {Human-readable time when the \class{LogRecord}
                         was created.  By default this is of the form
                         ``2003-07-08 16:49:45,896'' (the numbers after the
@@ -1481,7 +1484,7 @@
 information to be logged.
 
 \begin{classdesc}{LogRecord}{name, lvl, pathname, lineno, msg, args,
-                             exc_info}
+                             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
@@ -1491,7 +1494,9 @@
 which, together with \var{msg}, makes up the user message; and
 \var{exc_info} is the exception tuple obtained by calling
 \function{sys.exc_info() }(or \constant{None}, if no exception information
-is available).
+is available). The \var{func} is the name of the function from which the
+logging call was made. If not specified, it defaults to \var{None}.
+\versionchanged[\var{func} was added]{2.5}
 \end{classdesc}
 
 \begin{methoddesc}{getMessage}{}