[Python-checkins] cpython (3.4): Issue #25508: Clarify documentation on LogRecord args attribute.

[vinay.sajip]

https://hg.python.org/cpython/rev/01998efb605a
changeset:   99335:01998efb605a
branch:      3.4
parent:      99330:16fec577fd8b
user:        Vinay Sajip <vinay_sajip at yahoo.co.uk>
date:        Tue Nov 24 23:21:15 2015 +0000
summary:
  Issue #25508: Clarify documentation on LogRecord args attribute.

files:
  Doc/library/logging.rst |  4 +++-
  1 files changed, 3 insertions(+), 1 deletions(-)


diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -738,7 +738,9 @@
 | Attribute name | Format                  | Description                                   |
 +================+=========================+===============================================+
 | args           | You shouldn't need to   | The tuple of arguments merged into ``msg`` to |
-|                | format this yourself.   | produce ``message``.                          |
+|                | format this yourself.   | produce ``message``, or a dict whose values   |
+|                |                         | are used for the merge (when there is only one|
+|                |                         | argument, and it is a dictionary).            |
 +----------------+-------------------------+-----------------------------------------------+
 | asctime        | ``%(asctime)s``         | Human-readable time when the                  |
 |                |                         | :class:`LogRecord` was created.  By default   |

-- 
Repository URL: https://hg.python.org/cpython