]> granicus.if.org Git - python/commitdiff
logging.Formatter docs: Add missing `validate` parameter, clarify `style` parameter...
authorDavid Röthlisberger <david@stb-tester.com>
Mon, 9 Sep 2019 11:29:54 +0000 (12:29 +0100)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>
Mon, 9 Sep 2019 11:29:54 +0000 (12:29 +0100)
Doc/library/logging.rst

index cc611fc870862679f5e1d7c4be4f35a51ed19fe2..dec27bff564e630b07543be25c3269a3a2ff2e01 100644 (file)
@@ -528,7 +528,7 @@ The useful mapping keys in a :class:`LogRecord` are given in the section on
 :ref:`logrecord-attributes`.
 
 
-.. class:: Formatter(fmt=None, datefmt=None, style='%')
+.. class:: Formatter(fmt=None, datefmt=None, style='%', validate=True)
 
    Returns a new instance of the :class:`Formatter` class.  The instance is
    initialized with a format string for the message as a whole, as well as a
@@ -538,8 +538,11 @@ The useful mapping keys in a :class:`LogRecord` are given in the section on
 
    The *style* parameter can be one of '%', '{' or '$' and determines how
    the format string will be merged with its data: using one of %-formatting,
-   :meth:`str.format` or :class:`string.Template`. See :ref:`formatting-styles`
-   for more information on using {- and $-formatting for log messages.
+   :meth:`str.format` or :class:`string.Template`. This only applies to the
+   format string *fmt* (e.g. ``'%(message)s'`` or ``{message}``), not to the
+   actual log messages passed to ``Logger.debug`` etc; see
+   :ref:`formatting-styles` for more information on using {- and $-formatting
+   for log messages.
 
    .. versionchanged:: 3.2
       The *style* parameter was added.