[Python-checkins] logging.Formatter docs: Add missing `validate` parameter, clarify `style` parameter (GH-15222)

Mon Sep 9 07:29:57 EDT 2019

https://github.com/python/cpython/commit/4f0f9f066e72255c88d4ec9e9f8e510903577713
commit: 4f0f9f066e72255c88d4ec9e9f8e510903577713
branch: master
author: David Röthlisberger <david at stb-tester.com>
committer: Vinay Sajip <vinay_sajip at yahoo.co.uk>
date: 2019年09月09日T12:29:54+01:00
summary:
logging.Formatter docs: Add missing `validate` parameter, clarify `style` parameter (GH-15222)
files:
M Doc/library/logging.rst

diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index cc611fc87086..dec27bff564e 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -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.
