diff options
author | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2004-10-03 19:10:05 (GMT) |
---|---|---|
committer | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2004-10-03 19:10:05 (GMT) |
commit | 1dc5b1e5a2dfb6feb999742319cdcfc1bdf63f02 (patch) | |
tree | 1b4800aa2af23f35260b6bcde0cbdf852bc35c51 /Doc | |
parent | 130e37f3e263af29de31d75170ff665ec3ab076b (diff) | |
download | cpython-1dc5b1e5a2dfb6feb999742319cdcfc1bdf63f02.zip cpython-1dc5b1e5a2dfb6feb999742319cdcfc1bdf63f02.tar.gz cpython-1dc5b1e5a2dfb6feb999742319cdcfc1bdf63f02.tar.bz2 |
Clarified documentation about exc_info keyword parameter
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/lib/liblogging.tex | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/Doc/lib/liblogging.tex b/Doc/lib/liblogging.tex index 9b57870..2e857d9 100644 --- a/Doc/lib/liblogging.tex +++ b/Doc/lib/liblogging.tex @@ -162,8 +162,10 @@ Logs a message with level \constant{DEBUG} on the root logger. The \var{msg} is the message format string, and the \var{args} are the arguments which are merged into \var{msg}. The only keyword argument in \var{kwargs} which is inspected is \var{exc_info} which, if it does not -evaluate as false, causes exception information (via a call to -\function{sys.exc_info()}) to be added to the logging message. +evaluate as false, causes exception information to be added to the logging +message. If an exception tuple (in the format returned by +\function{sys.exc_info()}) is provided, it is used; otherwise, +\function{sys.exc_info()} is called to get the exception information. \end{funcdesc} \begin{funcdesc}{info}{msg\optional{, *args\optional{, **kwargs}}} @@ -310,8 +312,10 @@ Logs a message with level \constant{DEBUG} on this logger. The \var{msg} is the message format string, and the \var{args} are the arguments which are merged into \var{msg}. The only keyword argument in \var{kwargs} which is inspected is \var{exc_info} which, if it does not -evaluate as false, causes exception information (via a call to -\function{sys.exc_info()}) to be added to the logging message. +evaluate as false, causes exception information to be added to the logging +message. If an exception tuple (as provided by \function{sys.exc_info()}) +is provided, it is used; otherwise, \function{sys.exc_info()} is called +to get the exception information. \end{methoddesc} \begin{methoddesc}{info}{msg\optional{, *args\optional{, **kwargs}}} |