]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
#4811: fix markup glitches (mostly remains of the conversion),
authorGeorg Brandl <georg@python.org>
Fri, 2 Jan 2009 20:25:14 +0000 (20:25 +0000)
committerGeorg Brandl <georg@python.org>
Fri, 2 Jan 2009 20:25:14 +0000 (20:25 +0000)
found by Gabriel Genellina.

19 files changed:
Doc/ACKS.txt
Doc/c-api/arg.rst
Doc/distutils/apiref.rst
Doc/howto/functional.rst
Doc/howto/urllib2.rst
Doc/install/index.rst
Doc/library/cookielib.rst
Doc/library/email.mime.rst
Doc/library/gzip.rst
Doc/library/json.rst
Doc/library/multiprocessing.rst
Doc/library/numbers.rst
Doc/library/parser.rst
Doc/library/smtplib.rst
Doc/library/urlparse.rst
Doc/tutorial/inputoutput.rst
Doc/using/cmdline.rst
Doc/whatsnew/2.4.rst
Doc/whatsnew/2.5.rst

index 0bff6bdefeb55ce7e0713741bdb14c5d04099020..38c3dc22a82121769d4f28ff656ab024495ace76 100644 (file)
@@ -60,6 +60,7 @@ docs@python.org), and we'll be glad to correct the problem.
    * Peter Funk
    * Lele Gaifax
    * Matthew Gallagher
+   * Gabriel Genellina
    * Ben Gertzfield
    * Nadim Ghaznavi
    * Jonathan Giddy
index 144a36545d6b5a1320825f62e22db61449a4ed39..9d14d1c21d904e0967fe8e5fd8062374dad3f36f 100644 (file)
@@ -46,12 +46,12 @@ variable(s) whose address should be passed.
    :ctype:`Py_ssize_t` rather than an int.
 
 ``s*`` (string, Unicode, or any buffer compatible object) [Py_buffer \*]
-  Similar to ``s#``, this code fills a Py_buffer structure provided by the caller.
-  The buffer gets locked, so that the caller can subsequently use the buffer even
-  inside a ``Py_BEGIN_ALLOW_THREADS`` block; the caller is responsible for calling
-  ``PyBuffer_Release`` with the structure after it has processed the data.
+   Similar to ``s#``, this code fills a Py_buffer structure provided by the caller.
+   The buffer gets locked, so that the caller can subsequently use the buffer even
+   inside a ``Py_BEGIN_ALLOW_THREADS`` block; the caller is responsible for calling
+   ``PyBuffer_Release`` with the structure after it has processed the data.
 
-  .. versionadded:: 2.6
+   .. versionadded:: 2.6
 
 ``z`` (string or ``None``) [const char \*]
    Like ``s``, but the Python object may also be ``None``, in which case the C
@@ -63,7 +63,7 @@ variable(s) whose address should be passed.
 ``z*`` (string or ``None`` or any buffer compatible object) [Py_buffer*]
    This is to ``s*`` as ``z`` is to ``s``.
 
-  .. versionadded:: 2.6
+   .. versionadded:: 2.6
 
 ``u`` (Unicode object) [Py_UNICODE \*]
    Convert a Python Unicode object to a C pointer to a NUL-terminated buffer of
@@ -261,6 +261,7 @@ variable(s) whose address should be passed.
 
 ``w*`` (read-write byte-oriented buffer) [Py_buffer \*]
    This is to ``w`` what ``s*`` is to ``s``.
+
    .. versionadded:: 2.6
 
 ``(items)`` (tuple) [*matching-items*]
index 4a0d354547b3a1c0d55a49704d27060ba61678c6..f9222ece686597de8854b82450806a678adec917 100644 (file)
@@ -188,9 +188,10 @@ the full reference.
    |                        | for C/C++ header files (in     |                           |
    |                        | Unix form for portability)     |                           |
    +------------------------+--------------------------------+---------------------------+
-   | *define_macros*        | list of macros to define; each | (string,string)  tuple or |
-   |                        | macro is defined using a       | (name,``None``)           |
-   |                        | 2-tuple, where 'value' is      |                           |
+   | *define_macros*        | list of macros to define; each | (string, string) tuple or |
+   |                        | macro is defined using a       | (name, ``None``)          |
+   |                        | 2-tuple ``(name, value)``,     |                           |
+   |                        | where *value* is               |                           |
    |                        | either the string to define it |                           |
    |                        | to or ``None`` to define it    |                           |
    |                        | without a particular value     |                           |
index b717f80bf0543c23874fd1f949220c2937ac043b..6318e12de779d0af1b1e7131f6a14a7c6c5b5fc8 100644 (file)
@@ -585,7 +585,7 @@ And here's an example of changing the counter:
     9
     >>> print it.next()
     Traceback (most recent call last):
-      File ``t.py'', line 15, in ?
+      File "t.py", line 15, in ?
         print it.next()
     StopIteration
 
index 72f394afd313891363544647846907c8dcf4b813..6e1a2f30b17a3ce1736fc36dbf9856239ed9769c 100644 (file)
@@ -470,7 +470,7 @@ than the URL you pass to .add_password() will also match. ::
     password_mgr = urllib2.HTTPPasswordMgrWithDefaultRealm()                        
 
     # Add the username and password.
-    # If we knew the realm, we could use it instead of ``None``.
+    # If we knew the realm, we could use it instead of None.
     top_level_url = "http://example.com/foo/"
     password_mgr.add_password(None, top_level_url, username, password)
 
index 3f54b79b78de45d184534980d094317fb49f9bba..c8dcd2dbd432dc163a1c1b460115c32303253120 100644 (file)
@@ -587,7 +587,7 @@ value of ``sys.path``.   ::
    $ python
    Python 2.2 (#11, Oct  3 2002, 13:31:27)
    [GCC 2.96 20000731 (Red Hat Linux 7.3 2.96-112)] on linux2
-   Type ``help'', ``copyright'', ``credits'' or ``license'' for more information.
+   Type "help", "copyright", "credits" or "license" for more information.
    >>> import sys
    >>> sys.path
    ['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2', 
index 022ac13aab9a185aeede3dfaf6d95105256b484a..f55d6c2f065cdbc4f38754b429cb802f8f54d98a 100644 (file)
@@ -733,7 +733,7 @@ accessed using the following methods:
 The :class:`Cookie` class also defines the following method:
 
 
-.. method:: Cookie.is_expired([now=:const:`None`])
+.. method:: Cookie.is_expired([now=None])
 
    True if cookie has passed the time at which the server requested it should
    expire.  If *now* is given (in seconds since the epoch), return whether the
index 415a6825f929e2d1ec287c8dcec84a5279ab2563..5b20944eedf651f23abdf909a87d04e9f0fe01d9 100644 (file)
@@ -57,14 +57,14 @@ Here are the classes:
 
 .. currentmodule:: email.mime.multipart
 
-.. class:: MIMEMultipart([subtype[, boundary[, _subparts[, _params]]]])
+.. class:: MIMEMultipart([_subtype[, boundary[, _subparts[, _params]]]])
 
    Module: :mod:`email.mime.multipart`
 
    A subclass of :class:`MIMEBase`, this is an intermediate base class for MIME
    messages that are :mimetype:`multipart`.  Optional *_subtype* defaults to
    :mimetype:`mixed`, but can be used to specify the subtype of the message.  A
-   :mailheader:`Content-Type` header of :mimetype:`multipart/`*_subtype* will be
+   :mailheader:`Content-Type` header of :mimetype:`multipart/_subtype` will be
    added to the message object.  A :mailheader:`MIME-Version` header will also be
    added.
 
index 86be3cdd94d368ce5e489b3baf923d0a1aa9e9d3..c6f9ef82bd3182d2242a43a947b310b1c26cafac 100644 (file)
@@ -7,7 +7,7 @@
 This module provides a simple interface to compress and decompress files just
 like the GNU programs :program:`gzip` and :program:`gunzip` would.
 
-The data compression is provided by the :mod:``zlib`` module.
+The data compression is provided by the :mod:`zlib` module.
 
 The :mod:`gzip` module provides the :class:`GzipFile` class which is modeled
 after Python's File Object. The :class:`GzipFile` class reads and writes
index cf6138ed3fcdd1bfbfca487df1515f32eba63a99..5fb849859bea9ca4269ca11ba2a3105976db17ca 100644 (file)
@@ -152,7 +152,7 @@ Basic Usage
    *default(obj)* is a function that should return a serializable version of
    *obj* or raise :exc:`TypeError`.  The default simply raises :exc:`TypeError`.
 
-   To use a custom :class:`JSONEncoder`` subclass (e.g. one that overrides the
+   To use a custom :class:`JSONEncoder` subclass (e.g. one that overrides the
    :meth:`default` method to serialize additional types), specify it with the
    *cls* kwarg.
 
index 6f4a3f1bf14667fe941e112da22e0adfb0bcd289..bf2d058f14cf25b84d15a05042f4b04304581cb8 100644 (file)
@@ -1138,18 +1138,18 @@ their parent process exits.  The manager classes are defined in the
       
       Returns a :class:`Server` object which represents the actual server under
       the control of the Manager. The :class:`Server` object supports the 
-      :meth:`serve_forever` method::
+      :meth:`serve_forever` method:
       
-       >>> from multiprocessing.managers import BaseManager
-       >>> m = BaseManager(address=('', 50000), authkey='abc'))
-       >>> server = m.get_server()
-       >>> s.serve_forever()
+      >>> from multiprocessing.managers import BaseManager
+      >>> m = BaseManager(address=('', 50000), authkey='abc'))
+      >>> server = m.get_server()
+      >>> s.serve_forever()
        
-       :class:`Server` additionally have an :attr:`address` attribute.
+      :class:`Server` additionally have an :attr:`address` attribute.
 
    .. method:: connect()
    
-      Connect a local manager object to a remote manager process::
+      Connect a local manager object to a remote manager process:
       
       >>> from multiprocessing.managers import BaseManager
       >>> m = BaseManager(address='127.0.0.1', authkey='abc))
@@ -1295,7 +1295,7 @@ Customized managers
 >>>>>>>>>>>>>>>>>>>
 
 To create one's own manager, one creates a subclass of :class:`BaseManager` and
-use the :meth:`~BaseManager.resgister` classmethod to register new types or
+use the :meth:`~BaseManager.register` classmethod to register new types or
 callables with the manager class.  For example::
 
    from multiprocessing.managers import BaseManager
@@ -1811,7 +1811,7 @@ Address Formats
 
 * An ``'AF_PIPE'`` address is a string of the form
    :samp:`r'\\\\.\\pipe\\{PipeName}'`.  To use :func:`Client` to connect to a named
-   pipe on a remote computer called ServerName* one should use an address of the
+   pipe on a remote computer called *ServerName* one should use an address of the
    form :samp:`r'\\\\{ServerName}\\pipe\\{PipeName}'`` instead.
 
 Note that any string beginning with two backslashes is assumed by default to be
index b7aafb235840e1c9f83125f41ce8ea76d82f4301..b0d55a74066c0825e2d631d97857abbc99af000e 100644 (file)
@@ -51,14 +51,14 @@ The numeric tower
    :func:`round`, :func:`math.floor`, :func:`math.ceil`, :func:`divmod`, ``//``,
    ``%``, ``<``, ``<=``, ``>``, and ``>=``.
 
-   Real also provides defaults for :func:`complex`, :attr:`Complex.real`,
-   :attr:`Complex.imag`, and :meth:`Complex.conjugate`.
+   Real also provides defaults for :func:`complex`, :attr:`~Complex.real`,
+   :attr:`~Complex.imag`, and :meth:`~Complex.conjugate`.
 
 
 .. class:: Rational
 
    Subtypes :class:`Real` and adds
-   :attr:`Rational.numerator` and :attr:`Rational.denominator` properties, which
+   :attr:`~Rational.numerator` and :attr:`~Rational.denominator` properties, which
    should be in lowest terms. With these, it provides a default for
    :func:`float`.
 
@@ -74,8 +74,8 @@ The numeric tower
 .. class:: Integral
 
    Subtypes :class:`Rational` and adds a conversion to :class:`int`.
-   Provides defaults for :func:`float`, :attr:`Rational.numerator`, and
-   :attr:`Rational.denominator`, and bit-string operations: ``<<``,
+   Provides defaults for :func:`float`, :attr:`~Rational.numerator`, and
+   :attr:`~Rational.denominator`, and bit-string operations: ``<<``,
    ``>>``, ``&``, ``^``, ``|``, ``~``.
 
 
@@ -171,7 +171,7 @@ Complex``. I'll consider ``a + b``:
        knowledge of ``A``, so it can handle those instances before
        delegating to :class:`Complex`.
 
-If ``A<:Complex`` and ``B<:Real`` without sharing any other knowledge,
+If ``A <: Complex`` and ``B <: Real`` without sharing any other knowledge,
 then the appropriate shared operation is the one involving the built
 in :class:`complex`, and both :meth:`__radd__` s land there, so ``a+b
 == b+a``.
index bdd541cd3ea825b7278420e29c183e321c66e524..b1cbd1220c245da7ffcbc0f7e7e52e31381a7788 100644 (file)
@@ -641,7 +641,7 @@ on the same line as the definition of the code block, as in ::
 while the long form uses an indented block and allows nested definitions::
 
    def make_power(exp):
-       "Make a function that raises an argument to the exponent `exp'."
+       "Make a function that raises an argument to the exponent `exp`."
        def raiser(x, y=exp):
            return x ** y
        return raiser
index bdbbe4a0288658b2e8887b3b92259e08dcad568e..385f11684726010ecf1e3ac0af6ab56d60657732 100644 (file)
@@ -207,7 +207,7 @@ An :class:`SMTP` instance has the following methods:
    previous ``EHLO`` or ``HELO`` command this session.  It tries ESMTP ``EHLO``
    first.
 
-   :exc:SMTPHeloError
+   :exc:`SMTPHeloError`
      The server didn't reply properly to the ``HELO`` greeting.
 
    .. versionadded:: 2.6
index e7ed0f1051801bd086df8c0c14fcb81c81681a1d..40f889b47d9fa07e109893197ab7077a4e8e18df 100644 (file)
@@ -290,7 +290,7 @@ described in those functions, as well as provide an additional method:
 
    .. versionadded:: 2.5
 
-The following classes provide the implementations of the parse results::
+The following classes provide the implementations of the parse results:
 
 
 .. class:: BaseResult
index 7287e3e7846e3bc1eb86f6d1b6284ff3a981bcb4..ef783ae91c2e4464dee6afae518e0f397c285e19 100644 (file)
@@ -148,7 +148,7 @@ Positional and keyword arguments can be arbitrarily combined::
    ...                                                    other='Georg')
    The story of Bill, Manfred, and Georg.
 
-An optional ``':``` and format specifier can follow the field name. This also
+An optional ``':'`` and format specifier can follow the field name. This also
 greater control over how the value is formatted.  The following example
 truncates the Pi to three places after the decimal.
 
index 954df895b8c1779f30c16f0c8897123264ceb02f..b3a44aafeccdb36dc01a7ecac832603001a65d7d 100644 (file)
@@ -404,7 +404,7 @@ These environment variables influence Python's behavior.
    compiled form). Extension modules cannot be imported from zipfiles.
    
    The default search path is installation dependent, but generally begins with
-   :file:`{prefix}/lib/python{version}`` (see :envvar:`PYTHONHOME` above).  It
+   :file:`{prefix}/lib/python{version}` (see :envvar:`PYTHONHOME` above).  It
    is *always* appended to :envvar:`PYTHONPATH`.
    
    An additional directory will be inserted in the search path in front of
index 59788baba44e458a2993b7832b32e9ce28368aa4..4d6b659c502523c2d854ee2ab530edfc352b91f3 100644 (file)
@@ -1428,7 +1428,7 @@ Running the above function's tests with :const:`doctest.REPORT_UDIFF` specified,
 you get the following output::
 
    **********************************************************************
-   File ``t.py'', line 15, in g
+   File "t.py", line 15, in g
    Failed example:
        g(4)
    Differences (unified diff with -expected +actual):
index 43ba6e5a6351fbdbedda486acd128d8f6cfca2b5..58dbe4f3fb48ca1c6ae8513590f09249cb7adcbd 100644 (file)
@@ -485,7 +485,7 @@ And here's an example of changing the counter::
    9
    >>> print it.next()
    Traceback (most recent call last):
-     File ``t.py'', line 15, in ?
+     File "t.py", line 15, in ?
        print it.next()
    StopIteration