Issue #22251: Fix ReST markup to avoid errors building docs.

diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst
index 45b57211b679e2ccf483015a8153809daaa432b2..2dfcdc0f3177681f81bc2bf6e1b8a0d630b372c8 100644 (file)
--- a/Doc/extending/newtypes.rst
+++ b/Doc/extending/newtypes.rst
@@ -983,6 +983,7 @@ done.  This can be done using the :c:func:`PyErr_Fetch` and
    }
 
 .. note::
+
    There are limitations to what you can safely do in a deallocator function.
    First, if your type supports garbage collection (using :c:member:`~PyTypeObject.tp_traverse`
    and/or :c:member:`~PyTypeObject.tp_clear`), some of the object's members can have been
@@ -997,6 +998,7 @@ done.  This can be done using the :c:func:`PyErr_Fetch` and
    :c:member:`~PyTypeObject.tp_finalize` type method.
 
    .. seealso::
+
       :pep:`442` explains the new finalization scheme.
 
 .. index::

diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst
index 5f4ff1797b7b805be7dc99604eb5ac0f2f73d16c..a89eaa23a9e616df69181a0c10d9f8e854135f60 100644 (file)
--- a/Doc/faq/library.rst
+++ b/Doc/faq/library.rst
@@ -697,7 +697,9 @@ quoted using :func:`urllib.parse.urlencode`.  For example, to send
    >>> urllib.parse.urlencode({'name': 'Guy Steele, Jr.'})
    'name=Guy+Steele%2C+Jr.'
 
-.. seealso:: :ref:`urllib-howto` for extensive examples.
+.. seealso::
+
+   :ref:`urllib-howto` for extensive examples.
 
 
 What module should I use to help with generating HTML?

diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 3260667647a3e239d36af694c0f07748c021149c..9a3514c87e81b82c389bcbf58316eb3dca24442d 100644 (file)
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -1894,6 +1894,7 @@ the populated namespace and the list of remaining argument strings.
    (Namespace(bar='BAR', foo=True), ['--badger', 'spam'])
 
 .. warning::
+
    :ref:`Prefix matching <prefix-matching>` rules apply to
    :meth:`parse_known_args`. The parser may consume an option even if it's just
    a prefix of one of its known options, instead of leaving it in the remaining

diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index 8706b41ff4702cca96b981d791d47c679f38f37a..cc848aab13d42dfeaf0b556491cb7321afb8a61c 100644 (file)
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -197,7 +197,9 @@ Creating connections
      the transport; if *ssl* is :const:`True`, a context with some
      unspecified default settings is used.
 
-     .. seealso:: :ref:`SSL/TLS security considerations <ssl-security>`
+     .. seealso::
+
+        :ref:`SSL/TLS security considerations <ssl-security>`
 
    * *server_hostname*, is only for use together with *ssl*,
      and sets or overrides the hostname that the target server's certificate

diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst
index 92b055a7b5672592361824fed234bbfbc5039f8e..4299a2181934faf20355f2335a2fb71aa6b065ce 100644 (file)
--- a/Doc/library/asyncio-protocol.rst
+++ b/Doc/library/asyncio-protocol.rst
@@ -407,6 +407,7 @@ even more), and eventually :meth:`resume_writing` is called once when the
 buffer size reaches the low-water mark.
 
 .. note::
+
    If the buffer size equals the high-water mark,
    :meth:`pause_writing` is not called -- it must go strictly over.
    Conversely, :meth:`resume_writing` is called when the buffer size is
@@ -415,6 +416,7 @@ buffer size reaches the low-water mark.
    mark is zero.
 
 .. note::
+
    On BSD systems (OS X, FreeBSD, etc.) flow control is not supported
    for :class:`DatagramProtocol`, because send failures caused by
    writing too many packets cannot be detected easily.  The socket

diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index e7c316df9e9273b6a98db74bd9564b80c18c960a..3223001f2d5e3b437e13693c46985ce384fc2c64 100644 (file)
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -269,6 +269,7 @@ and it stores the result into the future. The
 the future.
 
 .. note::
+
    The :meth:`~BaseEventLoop.run_until_complete` method uses internally the
    :meth:`~Future.add_done_callback` method to be notified when the future is
    done.

diff --git a/Doc/library/email.contentmanager.rst b/Doc/library/email.contentmanager.rst
index 8f33a146dd874c6ea3d9a28126628a38a7a6d93b..ba2f5ea4b922aac2fbf0acf8ce8d2835b340938b 100644 (file)
--- a/Doc/library/email.contentmanager.rst
+++ b/Doc/library/email.contentmanager.rst
@@ -405,7 +405,9 @@ Currently the email package provides only one concrete content manager,
        ``message/rfc822``, use ``8bit`` if *cte* is not specified.  For all
        other values of *subtype*, use ``7bit``.
 
-       .. note:: A *cte* of ``binary`` does not actually work correctly yet.
+       .. note::
+
+          A *cte* of ``binary`` does not actually work correctly yet.
           The ``Message`` object as modified by ``set_content`` is correct, but
           :class:`~email.generator.BytesGenerator` does not serialize it
           correctly.

diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst
index a2b14de1b013197f67dfbec355744b101140a145..37678f0188114901486cc726c5f816d3578a87b1 100644 (file)
--- a/Doc/library/logging.handlers.rst
+++ b/Doc/library/logging.handlers.rst
@@ -864,7 +864,9 @@ supports sending logging messages to a Web server, using either ``GET`` or
       :meth:`mapLogRecord` method is used to convert the record to the
       dictionary to be sent.
 
-   .. note:: Since preparing a record for sending it to a Web server is not
+   .. note::
+
+      Since preparing a record for sending it to a Web server is not
       the same as a generic formatting operation, using
       :meth:`~logging.Handler.setFormatter` to specify a
       :class:`~logging.Formatter` for a :class:`HTTPHandler` has no effect.

diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index e568e68faddb8658aca4b6343b0d6150c7042451..1121f07c34185e136391fed43d224143ade4ddcd 100644 (file)
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -851,6 +851,7 @@ Miscellaneous
    :exc:`NotImplementedError`.
 
    .. seealso::
+
       :func:`os.cpu_count`
 
 .. function:: current_process()

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 0a59108b2c083b66aed928262217e4d7d18d52a5..b9eaba0ccfaa0afbc92dd7941813db85133f8008 100644 (file)
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -57,6 +57,7 @@ Notes on the availability of these functions:
    ``'ce'``, ``'java'``.
 
    .. seealso::
+
       :attr:`sys.platform` has a finer granularity.  :func:`os.uname` gives
       system-dependent version information.
 

diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index ec1dc4f6168cfd7e5d94d810df396a7998cebed2..ba0bcbf05faa4de28167e4e35e86212552c4abd6 100644 (file)
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -32,15 +32,18 @@ Pure paths are useful in some special cases; for example:
    useful since those simply don't have any OS-accessing operations.
 
 .. note::
+
    This module has been included in the standard library on a
    :term:`provisional basis <provisional package>`. Backwards incompatible
    changes (up to and including removal of the package) may occur if deemed
    necessary by the core developers.
 
 .. seealso::
+
    :pep:`428`: The pathlib module -- object-oriented filesystem paths.
 
 .. seealso::
+
    For low-level path manipulation on strings, you can also use the
    :mod:`os.path` module.
 

diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst
index ce5467fcf5e036237c8962b6e146716658ef238a..aceb68616d0ea282e80fdf1ee1474836d13d500c 100644 (file)
--- a/Doc/library/pickle.rst
+++ b/Doc/library/pickle.rst
@@ -141,6 +141,7 @@ to read the pickle produced.
   brought by protocol 4.
 
 .. note::
+
    Serialization is a more primitive notion than persistence; although
    :mod:`pickle` reads and writes file objects, it does not handle the issue of
    naming persistent objects, nor the (even more complicated) issue of concurrent

diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index 5ab6c14d8ed4ca267ee1005b9d488836d3a1ecec..676e937103838855f810296bc7313ded1e8cb9d1 100644 (file)
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -259,6 +259,7 @@ purposes.
    default CA certificates.
 
    .. note::
+
       The protocol, options, cipher and other settings may change to more
       restrictive values anytime without prior deprecation.  The values
       represent a fair balance between compatibility and security.
@@ -267,6 +268,7 @@ purposes.
       :class:`SSLContext` and apply the settings yourself.
 
    .. note::
+
       If you find that when certain older clients or servers attempt to connect
       with a :class:`SSLContext` created by this function that they get an
       error stating "Protocol or cipher suite mismatch", it may be that they
@@ -932,6 +934,7 @@ to speed up repeated connections from the same clients.
    interoperability.
 
    .. seealso::
+
       :func:`create_default_context` lets the :mod:`ssl` module choose
       security settings for a given purpose.
 

diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst
index 4e7783872a466c91b8bb2a7e5f4eca3ddc780315..7058e40faf3462ba91f973fe7b507e4aeada00c1 100644 (file)
--- a/Doc/library/statistics.rst
+++ b/Doc/library/statistics.rst
@@ -135,7 +135,9 @@ However, for reading convenience, most of the examples show sorted sequences.
    This is suited for when your data is discrete, and you don't mind that the
    median may not be an actual data point.
 
-   .. seealso:: :func:`median_low`, :func:`median_high`, :func:`median_grouped`
+   .. seealso::
+
+      :func:`median_low`, :func:`median_high`, :func:`median_grouped`
 
 
 .. function:: median_low(data)

diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 8778212cdb61873c67f7ff1ed800fe758024f893..fa715d30796230e854cd03523acc1b2752f14d44 100644 (file)
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -3872,6 +3872,7 @@ pairs within braces, for example: ``{'jack': 4098, 'sjoerd': 4127}`` or ``{4098:
       :ref:`documentation of view objects <dict-views>`.
 
 .. seealso::
+
    :class:`types.MappingProxyType` can be used to create a read-only view
    of a :class:`dict`.
 

diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index bee309ec521d50b403e254e2f991e9f44e99a122..fe3dc75bb97d00cf807d50cf504a056b6092337a 100644 (file)
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -798,6 +798,7 @@ always available.
 
 
    .. seealso::
+
       Module :mod:`site` This describes how to use .pth files to extend
       :data:`sys.path`.
 

diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst
index 8a538adb9b0282641a4360c96336f572af29d318..5ca833614edde92b1fe567890c8201861f7eb887 100644 (file)
--- a/Doc/library/warnings.rst
+++ b/Doc/library/warnings.rst
@@ -41,6 +41,7 @@ message by calling :func:`formatwarning`, which is also available for use by
 custom implementations.
 
 .. seealso::
+
    :func:`logging.captureWarnings` allows you to handle all warnings with
    the standard logging infrastructure.
 

diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index 55e0e678e9263b7dcb258e4635a10db00b976755..162b61316a2580943213f4de31bdf872eb9fea0a 100644 (file)
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -107,6 +107,7 @@ source.
        python -mtimeit -h # for details
 
    .. seealso::
+
       :func:`runpy.run_module`
          Equivalent functionality directly available to Python code
 
@@ -158,7 +159,9 @@ automatically enabled, if available on your platform (see
 .. versionchanged:: 3.4
    Automatic enabling of tab-completion and history editing.
 
-.. seealso::  :ref:`tut-invoking`
+.. seealso::
+
+   :ref:`tut-invoking`
 
 
 Generic options
@@ -362,6 +365,7 @@ Miscellaneous options
    thus equivalent to an omitted line number.
 
    .. seealso::
+
       :mod:`warnings` -- the warnings module
 
       :pep:`230` -- Warning framework