Skip to content

Commit

Permalink
logging.Formatter docs: Add missing validate parameter, clarify `st…
Browse files Browse the repository at this point in the history
…yle` parameter (pythonGH-15222)
  • Loading branch information
drothlis authored and vsajip committed Sep 9, 2019
1 parent 9d60706 commit 4f0f9f0
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions Doc/library/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 4f0f9f0

Please sign in to comment.