From fc29f27c162a236d2d879ab3fb803110628a0ccf Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Fri, 2 Jan 2009 20:25:14 +0000 Subject: [PATCH] #4811: fix markup glitches (mostly remains of the conversion), found by Gabriel Genellina. --- Doc/ACKS.txt | 1 + Doc/c-api/arg.rst | 13 +++++++------ Doc/distutils/apiref.rst | 7 ++++--- Doc/howto/functional.rst | 2 +- Doc/howto/urllib2.rst | 2 +- Doc/install/index.rst | 2 +- Doc/library/cookielib.rst | 2 +- Doc/library/email.mime.rst | 4 ++-- Doc/library/gzip.rst | 2 +- Doc/library/json.rst | 2 +- Doc/library/multiprocessing.rst | 18 +++++++++--------- Doc/library/numbers.rst | 12 ++++++------ Doc/library/parser.rst | 2 +- Doc/library/smtplib.rst | 2 +- Doc/library/urlparse.rst | 2 +- Doc/tutorial/inputoutput.rst | 2 +- Doc/using/cmdline.rst | 2 +- Doc/whatsnew/2.4.rst | 2 +- Doc/whatsnew/2.5.rst | 2 +- 19 files changed, 42 insertions(+), 39 deletions(-) diff --git a/Doc/ACKS.txt b/Doc/ACKS.txt index 0bff6bdefeb5..38c3dc22a821 100644 --- a/Doc/ACKS.txt +++ b/Doc/ACKS.txt @@ -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 diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst index 144a36545d6b..9d14d1c21d90 100644 --- a/Doc/c-api/arg.rst +++ b/Doc/c-api/arg.rst @@ -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*] diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst index 4a0d354547b3..f9222ece6865 100644 --- a/Doc/distutils/apiref.rst +++ b/Doc/distutils/apiref.rst @@ -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 | | diff --git a/Doc/howto/functional.rst b/Doc/howto/functional.rst index b717f80bf054..6318e12de779 100644 --- a/Doc/howto/functional.rst +++ b/Doc/howto/functional.rst @@ -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 diff --git a/Doc/howto/urllib2.rst b/Doc/howto/urllib2.rst index 72f394afd313..6e1a2f30b17a 100644 --- a/Doc/howto/urllib2.rst +++ b/Doc/howto/urllib2.rst @@ -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) diff --git a/Doc/install/index.rst b/Doc/install/index.rst index 3f54b79b78de..c8dcd2dbd432 100644 --- a/Doc/install/index.rst +++ b/Doc/install/index.rst @@ -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', diff --git a/Doc/library/cookielib.rst b/Doc/library/cookielib.rst index 022ac13aab9a..f55d6c2f065c 100644 --- a/Doc/library/cookielib.rst +++ b/Doc/library/cookielib.rst @@ -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 diff --git a/Doc/library/email.mime.rst b/Doc/library/email.mime.rst index 415a6825f929..5b20944eedf6 100644 --- a/Doc/library/email.mime.rst +++ b/Doc/library/email.mime.rst @@ -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. diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index 86be3cdd94d3..c6f9ef82bd31 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -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 diff --git a/Doc/library/json.rst b/Doc/library/json.rst index cf6138ed3fcd..5fb849859bea 100644 --- a/Doc/library/json.rst +++ b/Doc/library/json.rst @@ -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. diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 6f4a3f1bf146..bf2d058f14cf 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -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 diff --git a/Doc/library/numbers.rst b/Doc/library/numbers.rst index b7aafb235840..b0d55a74066c 100644 --- a/Doc/library/numbers.rst +++ b/Doc/library/numbers.rst @@ -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``. diff --git a/Doc/library/parser.rst b/Doc/library/parser.rst index bdd541cd3ea8..b1cbd1220c24 100644 --- a/Doc/library/parser.rst +++ b/Doc/library/parser.rst @@ -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 diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst index bdbbe4a02886..385f11684726 100644 --- a/Doc/library/smtplib.rst +++ b/Doc/library/smtplib.rst @@ -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 diff --git a/Doc/library/urlparse.rst b/Doc/library/urlparse.rst index e7ed0f105180..40f889b47d9f 100644 --- a/Doc/library/urlparse.rst +++ b/Doc/library/urlparse.rst @@ -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 diff --git a/Doc/tutorial/inputoutput.rst b/Doc/tutorial/inputoutput.rst index 7287e3e7846e..ef783ae91c2e 100644 --- a/Doc/tutorial/inputoutput.rst +++ b/Doc/tutorial/inputoutput.rst @@ -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. diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 954df895b8c1..b3a44aafeccd 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -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 diff --git a/Doc/whatsnew/2.4.rst b/Doc/whatsnew/2.4.rst index 59788baba44e..4d6b659c5025 100644 --- a/Doc/whatsnew/2.4.rst +++ b/Doc/whatsnew/2.4.rst @@ -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): diff --git a/Doc/whatsnew/2.5.rst b/Doc/whatsnew/2.5.rst index 43ba6e5a6351..58dbe4f3fb48 100644 --- a/Doc/whatsnew/2.5.rst +++ b/Doc/whatsnew/2.5.rst @@ -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 -- 2.47.3