Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit fa5e6e4

Browse files
committed
Fix note markup (#16805).
Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.
1 parent d0fc83d commit fa5e6e4

13 files changed

Lines changed: 28 additions & 6 deletions

File tree

Doc/c-api/arg.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ in any early abort case).
4545
Unless otherwise stated, buffers are not NUL-terminated.
4646

4747
.. note::
48+
4849
For all ``#`` variants of formats (``s#``, ``y#``, etc.), the type of
4950
the length argument (int or :c:type:`Py_ssize_t`) is controlled by
5051
defining the macro :c:macro:`PY_SSIZE_T_CLEAN` before including

Doc/c-api/init.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -548,6 +548,7 @@ code, or when embedding the Python interpreter:
548548
.. index:: module: _thread
549549
550550
.. note::
551+
551552
When only the main thread exists, no GIL operations are needed. This is a
552553
common situation (most Python programs do not use threads), and the lock
553554
operations slow the interpreter down a bit. Therefore, the lock is not

Doc/faq/library.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,7 @@ For data that is more regular (e.g. a homogeneous list of ints or floats),
509509
you can also use the :mod:`array` module.
510510

511511
.. note::
512+
512513
To read and write binary data, it is mandatory to open the file in
513514
binary mode (here, passing ``"rb"`` to :func:`open`). If you use
514515
``"r"`` instead (the default), the file will be open in text mode

Doc/library/fractions.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,9 @@ another rational number, or from a string.
9999
value of *flt*, which must be a :class:`float`. Beware that
100100
``Fraction.from_float(0.3)`` is not the same value as ``Fraction(3, 10)``
101101

102-
.. note:: From Python 3.2 onwards, you can also construct a
102+
.. note::
103+
104+
From Python 3.2 onwards, you can also construct a
103105
:class:`Fraction` instance directly from a :class:`float`.
104106

105107

@@ -108,7 +110,9 @@ another rational number, or from a string.
108110
This class method constructs a :class:`Fraction` representing the exact
109111
value of *dec*, which must be a :class:`decimal.Decimal` instance.
110112

111-
.. note:: From Python 3.2 onwards, you can also construct a
113+
.. note::
114+
115+
From Python 3.2 onwards, you can also construct a
112116
:class:`Fraction` instance directly from a :class:`decimal.Decimal`
113117
instance.
114118

Doc/library/getopt.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
--------------
1111

1212
.. note::
13+
1314
The :mod:`getopt` module is a parser for command line options whose API is
1415
designed to be familiar to users of the C :c:func:`getopt` function. Users who
1516
are unfamiliar with the C :c:func:`getopt` function or who would like to write

Doc/library/io.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -681,6 +681,7 @@ than raw I/O does.
681681
:exc:`UnsupportedOperation`.
682682

683683
.. warning::
684+
684685
:class:`BufferedRWPair` does not attempt to synchronize accesses to
685686
its underlying raw streams. You should not pass it the same object
686687
as reader and writer; use :class:`BufferedRandom` instead.

Doc/library/logging.config.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,9 @@ in :mod:`logging` itself) and defining handlers which are declared either in
115115
send it to the socket as a string of bytes preceded by a four-byte length
116116
string packed in binary using ``struct.pack('>L', n)``.
117117

118-
.. note:: Because portions of the configuration are passed through
118+
.. note::
119+
120+
Because portions of the configuration are passed through
119121
:func:`eval`, use of this function may open its users to a security risk.
120122
While the function only binds to a socket on ``localhost``, and so does
121123
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
714716
:class:`~logging.Formatter` can present exception tracebacks in an expanded or
715717
condensed format.
716718

717-
.. note:: Due to the use of :func:`eval` as described above, there are
719+
.. note::
720+
721+
Due to the use of :func:`eval` as described above, there are
718722
potential security risks which result from using the :func:`listen` to send
719723
and receive configurations via sockets. The risks are limited to where
720724
multiple users with no mutual trust run code on the same machine; see the

Doc/library/os.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,9 @@ process and user.
260260

261261
Availability: Unix.
262262

263-
.. note:: On Mac OS X, :func:`getgroups` behavior differs somewhat from
263+
.. note::
264+
265+
On Mac OS X, :func:`getgroups` behavior differs somewhat from
264266
other Unix platforms. If the Python interpreter was built with a
265267
deployment target of :const:`10.5` or earlier, :func:`getgroups` returns
266268
the list of effective group ids associated with the current user process;

Doc/library/pkgutil.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ support.
146146
*prefix* is a string to output on the front of every module name on output.
147147

148148
.. note::
149+
149150
Only works for a :term:`finder` which defines an ``iter_modules()``
150151
method. This interface is non-standard, so the module also provides
151152
implementations for :class:`importlib.machinery.FileFinder` and
@@ -184,6 +185,7 @@ support.
184185
walk_packages(ctypes.__path__, ctypes.__name__ + '.')
185186

186187
.. note::
188+
187189
Only works for a :term:`finder` which defines an ``iter_modules()``
188190
method. This interface is non-standard, so the module also provides
189191
implementations for :class:`importlib.machinery.FileFinder` and

Doc/library/socket.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -755,6 +755,7 @@ to sockets.
755755
:keyword:`with` statement around them.
756756

757757
.. note::
758+
758759
:meth:`close()` releases the resource associated with a connection but
759760
does not necessarily close the connection immediately. If you want
760761
to close the connection in a timely fashion, call :meth:`shutdown()`

0 commit comments

Comments
 (0)