]> granicus.if.org Git - python/commitdiff
Fix note markup (#16805).
authorÉric Araujo <merwok@netwok.org>
Wed, 12 Mar 2014 23:35:54 +0000 (19:35 -0400)
committerÉric Araujo <merwok@netwok.org>
Wed, 12 Mar 2014 23:35:54 +0000 (19:35 -0400)
Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.

Doc/c-api/init.rst
Doc/library/getopt.rst
Doc/library/io.rst
Doc/library/logging.config.rst
Doc/library/os.rst
Doc/library/socket.rst

index 7a6b0a6aee28174366131186c438056f79945ad2..46fc93f481ce692a3fc58529d824f48824332d1e 100644 (file)
@@ -534,6 +534,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
index b454814b3b600402d4983a1489caf72ba97cecb3..2dfb102c2b6f7c6fe26af5bab4690cee4322961f 100644 (file)
@@ -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
index c2f5155a91dc771f80e6f99bbca21c32ffa36d8a..be208847da5eb70867f36b2e6152d690b2b28639 100644 (file)
@@ -644,6 +644,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.
index c83b02628345ec2396565ca2cf9f8ada98c3ac53..c618aa82ceee26a8da86000e2c9765e07b3440a6 100644 (file)
@@ -118,7 +118,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
@@ -721,7 +723,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
index fe030961aedfae7e487ef14208dc8fc7e74e0c39..a597a67d39dc8eba2b170c4c71bb8da930225da5 100644 (file)
@@ -157,7 +157,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;
index 80e3fb2efabbbb7be6047ec30ea45d7fe6df12f6..f6c711e07c5743b9c24ac655f5afa4f6cb3b03c2 100644 (file)
@@ -562,6 +562,7 @@ correspond to Unix system calls applicable to sockets.
    automatically closed when they are garbage-collected.
 
    .. 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()`