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 58c0f3d..28a434e 100644
--- a/Doc/c-api/arg.rst
+++ b/Doc/c-api/arg.rst
@@ -45,6 +45,7 @@
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 705509f..4dad2c8 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -548,6 +548,7 @@
.. 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 4755110..2566932 100644
--- a/Doc/faq/library.rst
+++ b/Doc/faq/library.rst
@@ -509,6 +509,7 @@
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 fba199b..c2c7401 100644
--- a/Doc/library/fractions.rst
+++ b/Doc/library/fractions.rst
@@ -99,7 +99,9 @@
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 @@
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 b6ab3df..f9a1e53 100644
--- 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 3d723c0..716767f 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -681,6 +681,7 @@
: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 453fab5..303b4d8 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -115,7 +115,9 @@
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 @@
: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 b11098e..72693f1 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -260,7 +260,9 @@
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 22d44eb..7c4f912 100644
--- a/Doc/library/pkgutil.rst
+++ b/Doc/library/pkgutil.rst
@@ -146,6 +146,7 @@
*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 @@
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 dbaa1b0..3a49eed 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -755,6 +755,7 @@
: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 ebc9a4e..aa5a52f 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -623,6 +623,7 @@
'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 22be62e..36c608c 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -227,7 +227,9 @@
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 c1270f4..c28536d 100644
--- a/Doc/library/test.rst
+++ b/Doc/library/test.rst
@@ -199,6 +199,7 @@
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.