[Python-checkins] cpython (2.7): Fix note markup (#16805).

Thu Mar 13 00:36:18 CET 2014

http://hg.python.org/cpython/rev/ca43fa662b0d
changeset: 89613:ca43fa662b0d
branch: 2.7
parent: 89610:de97d0334314
user: Éric Araujo <merwok at netwok.org>
date: Wed Mar 12 19:35:54 2014 -0400
summary:
 Fix note markup (#16805).
Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.
files:
 Doc/c-api/init.rst | 1 +
 Doc/library/getopt.rst | 1 +
 Doc/library/io.rst | 1 +
 Doc/library/logging.config.rst | 8 ++++++--
 Doc/library/os.rst | 4 +++-
 Doc/library/socket.rst | 1 +
 6 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -534,6 +534,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/library/getopt.rst b/Doc/library/getopt.rst
--- 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
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -644,6 +644,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
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -118,7 +118,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
@@ -721,7 +723,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
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -157,7 +157,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/socket.rst b/Doc/library/socket.rst
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -562,6 +562,7 @@
 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()`
-- 
Repository URL: http://hg.python.org/cpython
