summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAmin Alaee <mohammadamin.alaee@gmail.com>2023-03-24 15:00:32 (GMT)
committerGitHub <noreply@github.com>2023-03-24 15:00:32 (GMT)
commitf2e5a6ee628502d307a97f587788d7022a200229 (patch)
treef90374749924b0c0ecbb9395ee5f71c24c2a2557 /Doc
parentacfe02f3b05436658d92add6b168538b30f357f0 (diff)
downloadcpython-f2e5a6ee628502d307a97f587788d7022a200229.zip
cpython-f2e5a6ee628502d307a97f587788d7022a200229.tar.gz
cpython-f2e5a6ee628502d307a97f587788d7022a200229.tar.bz2
gh-102873: logging.LogRecord docs: improve description of `msg` parameter (#102875)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Diffstat (limited to 'Doc')
-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 34e98fc..22412e1 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -813,8 +813,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.