From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 27 Jan 2023 17:45:59 +0000 (-0800)
Subject: [3.11] [doc] Add some notices to logging configuration documentation. (GH-101373... 
X-Git-Tag: v3.11.2~33
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1016909a6d6d3b3abb689a4c2dac808217695e79;p=thirdparty%2FPython%2Fcpython.git

[3.11] [doc] Add some notices to logging configuration documentation. (GH-101373) (GH-101376)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
---

diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index c36ad497f708..671f3c89ee83 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -525,6 +525,11 @@ returned by the call::
 
     my.package.customFormatterFactory(bar='baz', spam=99.9, answer=42)
 
+.. warning:: The values for keys such as ``bar``, ``spam`` and ``answer`` in
+   the above example should not be configuration dictionaries or references such
+   as ``cfg://foo`` or ``ext://bar``, because they will not be processed by the
+   configuration machinery, but passed to the callable as-is.
+
 The key ``'()'`` has been used as the special key because it is not a
 valid keyword parameter name, and so will not clash with the names of
 the keyword arguments used in the call.  The ``'()'`` also serves as a
@@ -553,6 +558,11 @@ following configuration::
 the returned formatter will have attribute ``foo`` set to ``'bar'`` and
 attribute ``baz`` set to ``'bozz'``.
 
+.. warning:: The values for attributes such as ``foo`` and ``baz`` in
+   the above example should not be configuration dictionaries or references such
+   as ``cfg://foo`` or ``ext://bar``, because they will not be processed by the
+   configuration machinery, but set as attribute values as-is.
+
 
 .. _logging-config-dict-externalobj: