[Python-checkins] bpo-34065: Improve the markup of logging.basicConfig() arguments (GH-8153)

Serhiy Storchaka webhook-mailer at python.org
Sat Jul 7 08:36:44 EDT 2018


https://github.com/python/cpython/commit/2800dcf656229c2ca4c90b4ddbace0717c41bb9e
commit: 2800dcf656229c2ca4c90b4ddbace0717c41bb9e
branch: master
author: Dong-hee Na <donghee.na92 at gmail.com>
committer: Serhiy Storchaka <storchaka at gmail.com>
date: 2018-07-07T15:36:40+03:00
summary:

bpo-34065: Improve the markup of logging.basicConfig() arguments (GH-8153)

files:
A Misc/NEWS.d/next/Documentation/2018-07-07-20-38-41.bpo-34065.1snofM.rst
M Doc/library/logging.rst

diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 27294cfa2074..c63ea212e41f 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -1186,25 +1186,24 @@ functions.
    |              | with *filename* or *stream* - if both       |
    |              | are present, a ``ValueError`` is raised.    |
    +--------------+---------------------------------------------+
-   | ``force``    | If this keyword argument is specified as    |
+   | *force*      | If this keyword argument is specified as    |
    |              | true, any existing handlers attached to the |
    |              | root logger are removed and closed, before  |
    |              | carrying out the configuration as specified |
    |              | by the other arguments.                     |
    +--------------+---------------------------------------------+
 
-   .. versionchanged:: 3.8
-      The ``force`` argument was added.
-
    .. versionchanged:: 3.2
-      The ``style`` argument was added.
+      The *style* argument was added.
 
    .. versionchanged:: 3.3
-      The ``handlers`` argument was added. Additional checks were added to
+      The *handlers* argument was added. Additional checks were added to
       catch situations where incompatible arguments are specified (e.g.
-      ``handlers`` together with ``stream`` or ``filename``, or ``stream``
-      together with ``filename``).
+      *handlers* together with *stream* or *filename*, or *stream*
+      together with *filename*).
 
+   .. versionchanged:: 3.8
+      The *force* argument was added.
 
 .. function:: shutdown()
 
diff --git a/Misc/NEWS.d/next/Documentation/2018-07-07-20-38-41.bpo-34065.1snofM.rst b/Misc/NEWS.d/next/Documentation/2018-07-07-20-38-41.bpo-34065.1snofM.rst
new file mode 100644
index 000000000000..a3f9fb848f62
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2018-07-07-20-38-41.bpo-34065.1snofM.rst
@@ -0,0 +1 @@
+Fix wrongly written basicConfig documentation markup syntax



More information about the Python-checkins mailing list