gh-137985: Correct description of Formatter's datefmt param in logging documentation (GH-138530)

This commit is contained in:
W. H. Wang 2025-09-06 05:07:04 +08:00 committed by GitHub
parent e2c038f5be
commit 8368895049
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -671,8 +671,7 @@ Formatter Objects
which is just the logged message.
:type fmt: str
:param datefmt: A format string in the given *style* for
the date/time portion of the logged output.
:param datefmt: A format string for the date/time portion of the logged output.
If not specified, the default described in :meth:`formatTime` is used.
:type datefmt: str
@ -680,7 +679,7 @@ Formatter Objects
how the format string will be merged with its data: using one of
:ref:`old-string-formatting` (``%``), :meth:`str.format` (``{``)
or :class:`string.Template` (``$``). This only applies to
*fmt* and *datefmt* (e.g. ``'%(message)s'`` versus ``'{message}'``),
*fmt* (e.g. ``'%(message)s'`` versus ``'{message}'``),
not to the actual log messages passed to the logging methods.
However, there are :ref:`other ways <formatting-styles>`
to use ``{``- and ``$``-formatting for log messages.