Issue #24060: Made logging.Formatter documentation a little clearer.
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Sat, 2 May 2015 08:46:05 +0000 (09:46 +0100)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>
Sat, 2 May 2015 08:46:05 +0000 (09:46 +0100)
Doc/library/logging.rst

index 96861a7b9e39ec7ff971827afe0c926938e43aa8..90fb9b06d1c9e1301cd259e12367b0777872faf2 100644 (file)
@@ -481,7 +481,9 @@ Formatter Objects
 responsible for converting a :class:`LogRecord` to (usually) a string which can
 be interpreted by either a human or an external system. The base
 :class:`Formatter` allows a formatting string to be specified. If none is
-supplied, the default value of ``'%(message)s'`` is used.
+supplied, the default value of ``'%(message)s'`` is used, which just includes
+the message in the logging call. To have additional items of information in the
+formatted output (such as a timestamp), keep reading.
 
 A Formatter can be initialized with a format string which makes use of knowledge
 of the :class:`LogRecord` attributes - such as the default value mentioned above