Issue #22251: Fix ReST markup to avoid errors building docs. · pythoncapi/cpython@f7fee33 · GitHub
Skip to content

Commit f7fee33

Browse files
berkerpeksagberkerpeksag
committed
Issue python#22251: Fix ReST markup to avoid errors building docs.
2 parents 89c6ee2 + 3749404 commit f7fee33

18 files changed

Lines changed: 38 additions & 6 deletions

‎Doc/extending/newtypes.rst‎

Lines changed: 2 additions & 0 deletions

‎Doc/faq/library.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -697,7 +697,9 @@ quoted using :func:`urllib.parse.urlencode`. For example, to send
697697
>>> urllib.parse.urlencode({'name': 'Guy Steele, Jr.'})
698698
'name=Guy+Steele%2C+Jr.'
699699

700-
.. seealso:: :ref:`urllib-howto` for extensive examples.
700+
.. seealso::
701+
702+
:ref:`urllib-howto` for extensive examples.
701703

702704

703705
What module should I use to help with generating HTML?

‎Doc/library/argparse.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1894,6 +1894,7 @@ the populated namespace and the list of remaining argument strings.
18941894
(Namespace(bar='BAR', foo=True), ['--badger', 'spam'])
18951895

18961896
.. warning::
1897+
18971898
:ref:`Prefix matching <prefix-matching>` rules apply to
18981899
:meth:`parse_known_args`. The parser may consume an option even if it's just
18991900
a prefix of one of its known options, instead of leaving it in the remaining

‎Doc/library/asyncio-eventloop.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,9 @@ Creating connections
197197
the transport; if *ssl* is :const:`True`, a context with some
198198
unspecified default settings is used.
199199

200-
.. seealso:: :ref:`SSL/TLS security considerations <ssl-security>`
200+
.. seealso::
201+
202+
:ref:`SSL/TLS security considerations <ssl-security>`
201203

202204
* *server_hostname*, is only for use together with *ssl*,
203205
and sets or overrides the hostname that the target server's certificate

‎Doc/library/asyncio-protocol.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -407,6 +407,7 @@ even more), and eventually :meth:`resume_writing` is called once when the
407407
buffer size reaches the low-water mark.
408408

409409
.. note::
410+
410411
If the buffer size equals the high-water mark,
411412
:meth:`pause_writing` is not called -- it must go strictly over.
412413
Conversely, :meth:`resume_writing` is called when the buffer size is
@@ -415,6 +416,7 @@ buffer size reaches the low-water mark.
415416
mark is zero.
416417

417418
.. note::
419+
418420
On BSD systems (OS X, FreeBSD, etc.) flow control is not supported
419421
for :class:`DatagramProtocol`, because send failures caused by
420422
writing too many packets cannot be detected easily. The socket

‎Doc/library/asyncio-task.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,7 @@ and it stores the result into the future. The
269269
the future.
270270

271271
.. note::
272+
272273
The :meth:`~BaseEventLoop.run_until_complete` method uses internally the
273274
:meth:`~Future.add_done_callback` method to be notified when the future is
274275
done.

‎Doc/library/email.contentmanager.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,9 @@ Currently the email package provides only one concrete content manager,
405405
``message/rfc822``, use ``8bit`` if *cte* is not specified. For all
406406
other values of *subtype*, use ``7bit``.
407407

408-
.. note:: A *cte* of ``binary`` does not actually work correctly yet.
408+
.. note::
409+
410+
A *cte* of ``binary`` does not actually work correctly yet.
409411
The ``Message`` object as modified by ``set_content`` is correct, but
410412
:class:`~email.generator.BytesGenerator` does not serialize it
411413
correctly.

‎Doc/library/logging.handlers.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -864,7 +864,9 @@ supports sending logging messages to a Web server, using either ``GET`` or
864864
:meth:`mapLogRecord` method is used to convert the record to the
865865
dictionary to be sent.
866866

867-
.. note:: Since preparing a record for sending it to a Web server is not
867+
.. note::
868+
869+
Since preparing a record for sending it to a Web server is not
868870
the same as a generic formatting operation, using
869871
:meth:`~logging.Handler.setFormatter` to specify a
870872
:class:`~logging.Formatter` for a :class:`HTTPHandler` has no effect.

‎Doc/library/multiprocessing.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -851,6 +851,7 @@ Miscellaneous
851851
:exc:`NotImplementedError`.
852852

853853
.. seealso::
854+
854855
:func:`os.cpu_count`
855856

856857
.. function:: current_process()

‎Doc/library/os.rst‎

Lines changed: 1 addition & 0 deletions

0 commit comments

Comments
 (0)