[Python-checkins] gh-102873: logging.LogRecord docs: improve description of `msg` parameter (GH-102875)
miss-islington
webhook-mailer at python.org
Fri Mar 24 11:08:56 EDT 2023
https://github.com/python/cpython/commit/c834a4c713f2fb55de1658bffd77d8ef070cf2d2
commit: c834a4c713f2fb55de1658bffd77d8ef070cf2d2
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2023-03-24T08:08:48-07:00
summary:
gh-102873: logging.LogRecord docs: improve description of `msg` parameter (GH-102875)
(cherry picked from commit f2e5a6ee628502d307a97f587788d7022a200229)
Co-authored-by: Amin Alaee <mohammadamin.alaee at gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood at Gmail.com>
files:
M Doc/library/logging.rst
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 9390f065fb26..6c47b9e206c4 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -796,8 +796,9 @@ wire).
:type lineno: int
:param msg: The event description message,
- which can be a %-format string with placeholders for variable data.
- :type msg: str
+ which can be a %-format string with placeholders for variable data,
+ or an arbitrary object (see :ref:`arbitrary-object-messages`).
+ :type msg: typing.Any
:param args: Variable data to merge into the *msg* argument
to obtain the event description.
More information about the Python-checkins
mailing list