[Python-checkins] r68171 - in python/trunk/Doc: ACKS.txt c-api/arg.rst distutils/apiref.rst howto/functional.rst howto/urllib2.rst install/index.rst library/cookielib.rst library/email.mime.rst library/gzip.rst library/json.rst library/multiprocessing.rst library/numbers.rst library/parser.rst library/smtplib.rst library/urlparse.rst tutorial/inputoutput.rst using/cmdline.rst whatsnew/2.4.rst whatsnew/2.5.rst

Fri Jan 2 21:25:14 CET 2009

Author: georg.brandl
Date: Fri Jan 2 21:25:14 2009
New Revision: 68171
Log:
#4811: fix markup glitches (mostly remains of the conversion),
found by Gabriel Genellina.
Modified:
 python/trunk/Doc/ACKS.txt
 python/trunk/Doc/c-api/arg.rst
 python/trunk/Doc/distutils/apiref.rst
 python/trunk/Doc/howto/functional.rst
 python/trunk/Doc/howto/urllib2.rst
 python/trunk/Doc/install/index.rst
 python/trunk/Doc/library/cookielib.rst
 python/trunk/Doc/library/email.mime.rst
 python/trunk/Doc/library/gzip.rst
 python/trunk/Doc/library/json.rst
 python/trunk/Doc/library/multiprocessing.rst
 python/trunk/Doc/library/numbers.rst
 python/trunk/Doc/library/parser.rst
 python/trunk/Doc/library/smtplib.rst
 python/trunk/Doc/library/urlparse.rst
 python/trunk/Doc/tutorial/inputoutput.rst
 python/trunk/Doc/using/cmdline.rst
 python/trunk/Doc/whatsnew/2.4.rst
 python/trunk/Doc/whatsnew/2.5.rst
Modified: python/trunk/Doc/ACKS.txt
==============================================================================

--- python/trunk/Doc/ACKS.txt	(original)
+++ python/trunk/Doc/ACKS.txt	Fri Jan 2 21:25:14 2009
@@ -60,6 +60,7 @@
 * Peter Funk
 * Lele Gaifax
 * Matthew Gallagher
+ * Gabriel Genellina
 * Ben Gertzfield
 * Nadim Ghaznavi
 * Jonathan Giddy
Modified: python/trunk/Doc/c-api/arg.rst
==============================================================================
--- python/trunk/Doc/c-api/arg.rst	(original)
+++ python/trunk/Doc/c-api/arg.rst	Fri Jan 2 21:25:14 2009
@@ -46,12 +46,12 @@
 :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 @@
 ``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 @@
 
 ``w*`` (read-write byte-oriented buffer) [Py_buffer \*]
 This is to ``w`` what ``s*`` is to ``s``.
+
 .. versionadded:: 2.6
 
 ``(items)`` (tuple) [*matching-items*]
Modified: python/trunk/Doc/distutils/apiref.rst
==============================================================================
--- python/trunk/Doc/distutils/apiref.rst	(original)
+++ python/trunk/Doc/distutils/apiref.rst	Fri Jan 2 21:25:14 2009
@@ -188,9 +188,10 @@
 | | 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 | |
Modified: python/trunk/Doc/howto/functional.rst
==============================================================================
--- python/trunk/Doc/howto/functional.rst	(original)
+++ python/trunk/Doc/howto/functional.rst	Fri Jan 2 21:25:14 2009
@@ -585,7 +585,7 @@
 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
 
Modified: python/trunk/Doc/howto/urllib2.rst
==============================================================================
--- python/trunk/Doc/howto/urllib2.rst	(original)
+++ python/trunk/Doc/howto/urllib2.rst	Fri Jan 2 21:25:14 2009
@@ -470,7 +470,7 @@
 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)
 
Modified: python/trunk/Doc/install/index.rst
==============================================================================
--- python/trunk/Doc/install/index.rst	(original)
+++ python/trunk/Doc/install/index.rst	Fri Jan 2 21:25:14 2009
@@ -587,7 +587,7 @@
 $ 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', 
Modified: python/trunk/Doc/library/cookielib.rst
==============================================================================
--- python/trunk/Doc/library/cookielib.rst	(original)
+++ python/trunk/Doc/library/cookielib.rst	Fri Jan 2 21:25:14 2009
@@ -733,7 +733,7 @@
 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
Modified: python/trunk/Doc/library/email.mime.rst
==============================================================================
--- python/trunk/Doc/library/email.mime.rst	(original)
+++ python/trunk/Doc/library/email.mime.rst	Fri Jan 2 21:25:14 2009
@@ -57,14 +57,14 @@
 
 .. 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.
 
Modified: python/trunk/Doc/library/gzip.rst
==============================================================================
--- python/trunk/Doc/library/gzip.rst	(original)
+++ python/trunk/Doc/library/gzip.rst	Fri Jan 2 21:25:14 2009
@@ -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
Modified: python/trunk/Doc/library/json.rst
==============================================================================
--- python/trunk/Doc/library/json.rst	(original)
+++ python/trunk/Doc/library/json.rst	Fri Jan 2 21:25:14 2009
@@ -152,7 +152,7 @@
 *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.
 
Modified: python/trunk/Doc/library/multiprocessing.rst
==============================================================================
--- python/trunk/Doc/library/multiprocessing.rst	(original)
+++ python/trunk/Doc/library/multiprocessing.rst	Fri Jan 2 21:25:14 2009
@@ -1138,18 +1138,18 @@
 
 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 @@
 >>>>>>>>>>>>>>>>>>>
 
 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 @@
 
 * 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
Modified: python/trunk/Doc/library/numbers.rst
==============================================================================
--- python/trunk/Doc/library/numbers.rst	(original)
+++ python/trunk/Doc/library/numbers.rst	Fri Jan 2 21:25:14 2009
@@ -51,14 +51,14 @@
 :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 @@
 .. 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 @@
 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``.
Modified: python/trunk/Doc/library/parser.rst
==============================================================================
--- python/trunk/Doc/library/parser.rst	(original)
+++ python/trunk/Doc/library/parser.rst	Fri Jan 2 21:25:14 2009
@@ -641,7 +641,7 @@
 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
Modified: python/trunk/Doc/library/smtplib.rst
==============================================================================
--- python/trunk/Doc/library/smtplib.rst	(original)
+++ python/trunk/Doc/library/smtplib.rst	Fri Jan 2 21:25:14 2009
@@ -207,7 +207,7 @@
 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
Modified: python/trunk/Doc/library/urlparse.rst
==============================================================================
--- python/trunk/Doc/library/urlparse.rst	(original)
+++ python/trunk/Doc/library/urlparse.rst	Fri Jan 2 21:25:14 2009
@@ -290,7 +290,7 @@
 
 .. 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
Modified: python/trunk/Doc/tutorial/inputoutput.rst
==============================================================================
--- python/trunk/Doc/tutorial/inputoutput.rst	(original)
+++ python/trunk/Doc/tutorial/inputoutput.rst	Fri Jan 2 21:25:14 2009
@@ -148,7 +148,7 @@
 ... 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.
 
Modified: python/trunk/Doc/using/cmdline.rst
==============================================================================
--- python/trunk/Doc/using/cmdline.rst	(original)
+++ python/trunk/Doc/using/cmdline.rst	Fri Jan 2 21:25:14 2009
@@ -404,7 +404,7 @@
 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
Modified: python/trunk/Doc/whatsnew/2.4.rst
==============================================================================
--- python/trunk/Doc/whatsnew/2.4.rst	(original)
+++ python/trunk/Doc/whatsnew/2.4.rst	Fri Jan 2 21:25:14 2009
@@ -1428,7 +1428,7 @@
 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):
Modified: python/trunk/Doc/whatsnew/2.5.rst
==============================================================================
--- python/trunk/Doc/whatsnew/2.5.rst	(original)
+++ python/trunk/Doc/whatsnew/2.5.rst	Fri Jan 2 21:25:14 2009
@@ -485,7 +485,7 @@
 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
 
