Fix note markup (#16805).

Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.

diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst
index 58c0f3d94dacfe95f5adc4b54944bbe8e9d24a5d..28a434e5a3a1fc877c10ec4a95f88e4396ef956e 100644 (file)
--- a/Doc/c-api/arg.rst
+++ b/Doc/c-api/arg.rst
@@ -45,6 +45,7 @@ in any early abort case).
 Unless otherwise stated, buffers are not NUL-terminated.
 
 .. note::
+
    For all ``#`` variants of formats (``s#``, ``y#``, etc.), the type of
    the length argument (int or :c:type:`Py_ssize_t`) is controlled by
    defining the macro :c:macro:`PY_SSIZE_T_CLEAN` before including

diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index 705509f42a67578ac5275a605c0dfa6b30e9a388..4dad2c814d02a95a1dbea2dd449746c6ddf36aaa 100644 (file)
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -548,6 +548,7 @@ code, or when embedding the Python interpreter:
    .. index:: module: _thread
 
    .. note::
+
       When only the main thread exists, no GIL operations are needed. This is a
       common situation (most Python programs do not use threads), and the lock
       operations slow the interpreter down a bit. Therefore, the lock is not

diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst
index 475511013601f3387ae1ede3b015fd570f08b128..2566932dc9250d8c59c6bf7fe45ee53224f73786 100644 (file)
--- a/Doc/faq/library.rst
+++ b/Doc/faq/library.rst
@@ -509,6 +509,7 @@ For data that is more regular (e.g. a homogeneous list of ints or floats),
 you can also use the :mod:`array` module.
 
 .. note::
+
    To read and write binary data, it is mandatory to open the file in
    binary mode (here, passing ``"rb"`` to :func:`open`).  If you use
    ``"r"`` instead (the default), the file will be open in text mode

diff --git a/Doc/library/fractions.rst b/Doc/library/fractions.rst
index fba199bf787731f38b9549815ad97850d4f2ecd6..c2c74013f046dec23370b11773c335907c30ff71 100644 (file)
--- a/Doc/library/fractions.rst
+++ b/Doc/library/fractions.rst
@@ -99,7 +99,9 @@ another rational number, or from a string.
       value of *flt*, which must be a :class:`float`. Beware that
       ``Fraction.from_float(0.3)`` is not the same value as ``Fraction(3, 10)``
 
-      .. note:: From Python 3.2 onwards, you can also construct a
+      .. note::
+
+         From Python 3.2 onwards, you can also construct a
          :class:`Fraction` instance directly from a :class:`float`.
 
 
@@ -108,7 +110,9 @@ another rational number, or from a string.
       This class method constructs a :class:`Fraction` representing the exact
       value of *dec*, which must be a :class:`decimal.Decimal` instance.
 
-      .. note:: From Python 3.2 onwards, you can also construct a
+      .. note::
+
+         From Python 3.2 onwards, you can also construct a
          :class:`Fraction` instance directly from a :class:`decimal.Decimal`
          instance.
 

diff --git a/Doc/library/getopt.rst b/Doc/library/getopt.rst
index b6ab3df02286905c45e22956c73d09923baea53b..f9a1e53e38ba5e315c4eed552e2dc7793fb42f5e 100644 (file)
--- a/Doc/library/getopt.rst
+++ b/Doc/library/getopt.rst
@@ -10,6 +10,7 @@
 --------------
 
 .. note::
+
    The :mod:`getopt` module is a parser for command line options whose API is
    designed to be familiar to users of the C :c:func:`getopt` function. Users who
    are unfamiliar with the C :c:func:`getopt` function or who would like to write

diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 3d723c09db2a3a3bd02a560b265ded6bd9fd7bad..716767f465ebc9e568a5dedb577ea67788c9f027 100644 (file)
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -681,6 +681,7 @@ than raw I/O does.
    :exc:`UnsupportedOperation`.
 
    .. warning::
+
       :class:`BufferedRWPair` does not attempt to synchronize accesses to
       its underlying raw streams.  You should not pass it the same object
       as reader and writer; use :class:`BufferedRandom` instead.

diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 453fab569459f6e6e0512c809d698c1fa56f3262..303b4d89b9097b6a3ba8153d3548abe8178b230b 100644 (file)
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -115,7 +115,9 @@ in :mod:`logging` itself) and defining handlers which are declared either in
    send it to the socket as a string of bytes preceded by a four-byte length
    string packed in binary using ``struct.pack('>L', n)``.
 
-   .. note:: Because portions of the configuration are passed through
+   .. note::
+
+      Because portions of the configuration are passed through
       :func:`eval`, use of this function may open its users to a security risk.
       While the function only binds to a socket on ``localhost``, and so does
       not accept connections from remote machines, there are scenarios where
@@ -714,7 +716,9 @@ The ``class`` entry is optional.  It indicates the name of the formatter's class
 :class:`~logging.Formatter` can present exception tracebacks in an expanded or
 condensed format.
 
-.. note:: Due to the use of :func:`eval` as described above, there are
+.. note::
+
+   Due to the use of :func:`eval` as described above, there are
    potential security risks which result from using the :func:`listen` to send
    and receive configurations via sockets. The risks are limited to where
    multiple users with no mutual trust run code on the same machine; see the

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index b11098e95f977856edf18b9b246f61a9ab069e6c..72693f14b0166ea94132b55ce4554e70bf7914be 100644 (file)
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -260,7 +260,9 @@ process and user.
 
    Availability: Unix.
 
-   .. note:: On Mac OS X, :func:`getgroups` behavior differs somewhat from
+   .. note::
+
+      On Mac OS X, :func:`getgroups` behavior differs somewhat from
       other Unix platforms. If the Python interpreter was built with a
       deployment target of :const:`10.5` or earlier, :func:`getgroups` returns
       the list of effective group ids associated with the current user process;

diff --git a/Doc/library/pkgutil.rst b/Doc/library/pkgutil.rst
index 22d44eb9bc77963ca0cd58ddf690a52b6a0c954e..7c4f9121fa78661f7be910860e3be38cfd869dcb 100644 (file)
--- a/Doc/library/pkgutil.rst
+++ b/Doc/library/pkgutil.rst
@@ -146,6 +146,7 @@ support.
    *prefix* is a string to output on the front of every module name on output.
 
    .. note::
+
       Only works for a :term:`finder` which defines an ``iter_modules()``
       method. This interface is non-standard, so the module also provides
       implementations for :class:`importlib.machinery.FileFinder` and
@@ -184,6 +185,7 @@ support.
       walk_packages(ctypes.__path__, ctypes.__name__ + '.')
 
    .. note::
+
       Only works for a :term:`finder` which defines an ``iter_modules()``
       method. This interface is non-standard, so the module also provides
       implementations for :class:`importlib.machinery.FileFinder` and

diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index dbaa1b0f8a8c445bc4d8062007c3cb83db75b8e0..3a49eed09dc9aa025e07fee23a0cf108281a0485 100644 (file)
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -755,6 +755,7 @@ to sockets.
    :keyword:`with` statement around them.
 
    .. note::
+
       :meth:`close()` releases the resource associated with a connection but
       does not necessarily close the connection immediately.  If you want
       to close the connection in a timely fashion, call :meth:`shutdown()`

diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index ebc9a4eab88366ad0b4f94d95986c34910ef0b06..aa5a52f62fdf74535c892af2d59f6b8b400d2d10 100644 (file)
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -623,6 +623,7 @@ SSL sockets also have the following additional methods and attributes:
        'version': 3}
 
    .. note::
+
       To validate a certificate for a particular service, you can use the
       :func:`match_hostname` function.
 

diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 22be62e11eec370fcd3b01578df3f4d1e76a6629..36c608cd352358a03a23b2a5cfa9c6ed76d9c406 100644 (file)
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -227,7 +227,9 @@ always available.
    installed in :file:`{exec_prefix}/lib/python{X.Y}/lib-dynload`, where *X.Y*
    is the version number of Python, for example ``3.2``.
 
-   .. note:: If a :ref:`virtual environment <venv-def>` is in effect, this
+   .. note::
+
+      If a :ref:`virtual environment <venv-def>` is in effect, this
       value will be changed in ``site.py`` to point to the virtual environment.
       The value for the Python installation will still be available, via
       :data:`base_exec_prefix`.

diff --git a/Doc/library/test.rst b/Doc/library/test.rst
index c1270f4320b1b68ff00fa0f8210a84dc43262284..c28536da0ba545d45f560fba20bedc0ee8155888 100644 (file)
--- a/Doc/library/test.rst
+++ b/Doc/library/test.rst
@@ -199,6 +199,7 @@ The :mod:`test.support` module provides support for Python's regression
 test suite.
 
 .. note::
+
    :mod:`test.support` is not a public module.  It is documented here to help
    Python developers write tests.  The API of this module is subject to change
    without backwards compatibility concerns between releases.