]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-34065: Improve the markup of logging.basicConfig() arguments (GH-8153)
authorDong-hee Na <donghee.na92@gmail.com>
Sat, 7 Jul 2018 12:36:40 +0000 (21:36 +0900)
committerSerhiy Storchaka <storchaka@gmail.com>
Sat, 7 Jul 2018 12:36:40 +0000 (15:36 +0300)
Doc/library/logging.rst
Misc/NEWS.d/next/Documentation/2018-07-07-20-38-41.bpo-34065.1snofM.rst [new file with mode: 0644]

index 27294cfa20741ad34fc272efa9792c60e63a8651..c63ea212e41f5aa6a521a1d7d742548ec9121123 100644 (file)
@@ -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 (file)
index 0000000..a3f9fb8
--- /dev/null
@@ -0,0 +1 @@
+Fix wrongly written basicConfig documentation markup syntax