Skip to content

gh-137985: correct description of Formatter's datefmt param in logging doc #138530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 5, 2025
+2 −3
Merged

gh-137985: correct description of Formatter's datefmt param in logging doc #138530

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c990cbd
correct description of Formatter's datefmt param in logging doc
mattwang44 Sep 5, 2025
2979801
also fix the description of style param
mattwang44 Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions Doc/library/logging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -671,16 +671,15 @@ 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

:param style: Can be one of ``'%'``, ``'{'`` or ``'$'`` and determines
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.
Expand Down
Loading