summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-03-24 08:08:48 -0700
committerGitHub <noreply@github.com>2023-03-24 08:08:48 -0700
commitc834a4c713f2fb55de1658bffd77d8ef070cf2d2 (patch)
treec831841020f6e9e07a96ee0e09294f4fcef319ff
parent[3.11] gh-102027: Fix macro name (GH-102124) (#102916) (diff)
downloadcpython-c834a4c713f2fb55de1658bffd77d8ef070cf2d2.tar.gz
cpython-c834a4c713f2fb55de1658bffd77d8ef070cf2d2.tar.bz2
cpython-c834a4c713f2fb55de1658bffd77d8ef070cf2d2.zip
gh-102873: logging.LogRecord docs: improve description of `msg` parameter (GH-102875)
(cherry picked from commit f2e5a6ee628502d307a97f587788d7022a200229) Co-authored-by: Amin Alaee <mohammadamin.alaee@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
-rw-r--r--Doc/library/logging.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 9390f065fb2..6c47b9e206c 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.