#4811: fix markup glitches (mostly remains of the conversion),
found by Gabriel Genellina.
This commit is contained in:
parent
511048673f
commit
fc29f27c16
|
@ -60,6 +60,7 @@ docs@python.org), and we'll be glad to correct the problem.
|
||||||
* Peter Funk
|
* Peter Funk
|
||||||
* Lele Gaifax
|
* Lele Gaifax
|
||||||
* Matthew Gallagher
|
* Matthew Gallagher
|
||||||
|
* Gabriel Genellina
|
||||||
* Ben Gertzfield
|
* Ben Gertzfield
|
||||||
* Nadim Ghaznavi
|
* Nadim Ghaznavi
|
||||||
* Jonathan Giddy
|
* Jonathan Giddy
|
||||||
|
|
|
@ -46,12 +46,12 @@ variable(s) whose address should be passed.
|
||||||
:ctype:`Py_ssize_t` rather than an int.
|
:ctype:`Py_ssize_t` rather than an int.
|
||||||
|
|
||||||
``s*`` (string, Unicode, or any buffer compatible object) [Py_buffer \*]
|
``s*`` (string, Unicode, or any buffer compatible object) [Py_buffer \*]
|
||||||
Similar to ``s#``, this code fills a Py_buffer structure provided by the caller.
|
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
|
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
|
inside a ``Py_BEGIN_ALLOW_THREADS`` block; the caller is responsible for calling
|
||||||
``PyBuffer_Release`` with the structure after it has processed the data.
|
``PyBuffer_Release`` with the structure after it has processed the data.
|
||||||
|
|
||||||
.. versionadded:: 2.6
|
.. versionadded:: 2.6
|
||||||
|
|
||||||
``z`` (string or ``None``) [const char \*]
|
``z`` (string or ``None``) [const char \*]
|
||||||
Like ``s``, but the Python object may also be ``None``, in which case the C
|
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*]
|
``z*`` (string or ``None`` or any buffer compatible object) [Py_buffer*]
|
||||||
This is to ``s*`` as ``z`` is to ``s``.
|
This is to ``s*`` as ``z`` is to ``s``.
|
||||||
|
|
||||||
.. versionadded:: 2.6
|
.. versionadded:: 2.6
|
||||||
|
|
||||||
``u`` (Unicode object) [Py_UNICODE \*]
|
``u`` (Unicode object) [Py_UNICODE \*]
|
||||||
Convert a Python Unicode object to a C pointer to a NUL-terminated buffer of
|
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 \*]
|
``w*`` (read-write byte-oriented buffer) [Py_buffer \*]
|
||||||
This is to ``w`` what ``s*`` is to ``s``.
|
This is to ``w`` what ``s*`` is to ``s``.
|
||||||
|
|
||||||
.. versionadded:: 2.6
|
.. versionadded:: 2.6
|
||||||
|
|
||||||
``(items)`` (tuple) [*matching-items*]
|
``(items)`` (tuple) [*matching-items*]
|
||||||
|
|
|
@ -188,9 +188,10 @@ the full reference.
|
||||||
| | for C/C++ header files (in | |
|
| | for C/C++ header files (in | |
|
||||||
| | Unix form for portability) | |
|
| | Unix form for portability) | |
|
||||||
+------------------------+--------------------------------+---------------------------+
|
+------------------------+--------------------------------+---------------------------+
|
||||||
| *define_macros* | list of macros to define; each | (string,string) tuple or |
|
| *define_macros* | list of macros to define; each | (string, string) tuple or |
|
||||||
| | macro is defined using a | (name,``None``) |
|
| | macro is defined using a | (name, ``None``) |
|
||||||
| | 2-tuple, where 'value' is | |
|
| | 2-tuple ``(name, value)``, | |
|
||||||
|
| | where *value* is | |
|
||||||
| | either the string to define it | |
|
| | either the string to define it | |
|
||||||
| | to or ``None`` to define it | |
|
| | to or ``None`` to define it | |
|
||||||
| | without a particular value | |
|
| | without a particular value | |
|
||||||
|
|
|
@ -585,7 +585,7 @@ And here's an example of changing the counter:
|
||||||
9
|
9
|
||||||
>>> print it.next()
|
>>> print it.next()
|
||||||
Traceback (most recent call last):
|
Traceback (most recent call last):
|
||||||
File ``t.py'', line 15, in ?
|
File "t.py", line 15, in ?
|
||||||
print it.next()
|
print it.next()
|
||||||
StopIteration
|
StopIteration
|
||||||
|
|
||||||
|
|
|
@ -470,7 +470,7 @@ than the URL you pass to .add_password() will also match. ::
|
||||||
password_mgr = urllib2.HTTPPasswordMgrWithDefaultRealm()
|
password_mgr = urllib2.HTTPPasswordMgrWithDefaultRealm()
|
||||||
|
|
||||||
# Add the username and password.
|
# 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/"
|
top_level_url = "http://example.com/foo/"
|
||||||
password_mgr.add_password(None, top_level_url, username, password)
|
password_mgr.add_password(None, top_level_url, username, password)
|
||||||
|
|
||||||
|
|
|
@ -587,7 +587,7 @@ value of ``sys.path``. ::
|
||||||
$ python
|
$ python
|
||||||
Python 2.2 (#11, Oct 3 2002, 13:31:27)
|
Python 2.2 (#11, Oct 3 2002, 13:31:27)
|
||||||
[GCC 2.96 20000731 (Red Hat Linux 7.3 2.96-112)] on linux2
|
[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
|
>>> import sys
|
||||||
>>> sys.path
|
>>> sys.path
|
||||||
['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2',
|
['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2',
|
||||||
|
|
|
@ -733,7 +733,7 @@ accessed using the following methods:
|
||||||
The :class:`Cookie` class also defines the following method:
|
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
|
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
|
expire. If *now* is given (in seconds since the epoch), return whether the
|
||||||
|
|
|
@ -57,14 +57,14 @@ Here are the classes:
|
||||||
|
|
||||||
.. currentmodule:: email.mime.multipart
|
.. currentmodule:: email.mime.multipart
|
||||||
|
|
||||||
.. class:: MIMEMultipart([subtype[, boundary[, _subparts[, _params]]]])
|
.. class:: MIMEMultipart([_subtype[, boundary[, _subparts[, _params]]]])
|
||||||
|
|
||||||
Module: :mod:`email.mime.multipart`
|
Module: :mod:`email.mime.multipart`
|
||||||
|
|
||||||
A subclass of :class:`MIMEBase`, this is an intermediate base class for MIME
|
A subclass of :class:`MIMEBase`, this is an intermediate base class for MIME
|
||||||
messages that are :mimetype:`multipart`. Optional *_subtype* defaults to
|
messages that are :mimetype:`multipart`. Optional *_subtype* defaults to
|
||||||
:mimetype:`mixed`, but can be used to specify the subtype of the message. A
|
: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 to the message object. A :mailheader:`MIME-Version` header will also be
|
||||||
added.
|
added.
|
||||||
|
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
This module provides a simple interface to compress and decompress files just
|
This module provides a simple interface to compress and decompress files just
|
||||||
like the GNU programs :program:`gzip` and :program:`gunzip` would.
|
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
|
The :mod:`gzip` module provides the :class:`GzipFile` class which is modeled
|
||||||
after Python's File Object. The :class:`GzipFile` class reads and writes
|
after Python's File Object. The :class:`GzipFile` class reads and writes
|
||||||
|
|
|
@ -152,7 +152,7 @@ Basic Usage
|
||||||
*default(obj)* is a function that should return a serializable version of
|
*default(obj)* is a function that should return a serializable version of
|
||||||
*obj* or raise :exc:`TypeError`. The default simply raises :exc:`TypeError`.
|
*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
|
:meth:`default` method to serialize additional types), specify it with the
|
||||||
*cls* kwarg.
|
*cls* kwarg.
|
||||||
|
|
||||||
|
|
|
@ -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
|
Returns a :class:`Server` object which represents the actual server under
|
||||||
the control of the Manager. The :class:`Server` object supports the
|
the control of the Manager. The :class:`Server` object supports the
|
||||||
:meth:`serve_forever` method::
|
:meth:`serve_forever` method:
|
||||||
|
|
||||||
>>> from multiprocessing.managers import BaseManager
|
>>> from multiprocessing.managers import BaseManager
|
||||||
>>> m = BaseManager(address=('', 50000), authkey='abc'))
|
>>> m = BaseManager(address=('', 50000), authkey='abc'))
|
||||||
>>> server = m.get_server()
|
>>> server = m.get_server()
|
||||||
>>> s.serve_forever()
|
>>> s.serve_forever()
|
||||||
|
|
||||||
:class:`Server` additionally have an :attr:`address` attribute.
|
:class:`Server` additionally have an :attr:`address` attribute.
|
||||||
|
|
||||||
.. method:: connect()
|
.. 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
|
>>> from multiprocessing.managers import BaseManager
|
||||||
>>> m = BaseManager(address='127.0.0.1', authkey='abc))
|
>>> 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
|
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::
|
callables with the manager class. For example::
|
||||||
|
|
||||||
from multiprocessing.managers import BaseManager
|
from multiprocessing.managers import BaseManager
|
||||||
|
@ -1811,7 +1811,7 @@ Address Formats
|
||||||
|
|
||||||
* An ``'AF_PIPE'`` address is a string of the form
|
* An ``'AF_PIPE'`` address is a string of the form
|
||||||
:samp:`r'\\\\.\\pipe\\{PipeName}'`. To use :func:`Client` to connect to a named
|
: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.
|
form :samp:`r'\\\\{ServerName}\\pipe\\{PipeName}'`` instead.
|
||||||
|
|
||||||
Note that any string beginning with two backslashes is assumed by default to be
|
Note that any string beginning with two backslashes is assumed by default to be
|
||||||
|
|
|
@ -51,14 +51,14 @@ The numeric tower
|
||||||
:func:`round`, :func:`math.floor`, :func:`math.ceil`, :func:`divmod`, ``//``,
|
:func:`round`, :func:`math.floor`, :func:`math.ceil`, :func:`divmod`, ``//``,
|
||||||
``%``, ``<``, ``<=``, ``>``, and ``>=``.
|
``%``, ``<``, ``<=``, ``>``, and ``>=``.
|
||||||
|
|
||||||
Real also provides defaults for :func:`complex`, :attr:`Complex.real`,
|
Real also provides defaults for :func:`complex`, :attr:`~Complex.real`,
|
||||||
:attr:`Complex.imag`, and :meth:`Complex.conjugate`.
|
:attr:`~Complex.imag`, and :meth:`~Complex.conjugate`.
|
||||||
|
|
||||||
|
|
||||||
.. class:: Rational
|
.. class:: Rational
|
||||||
|
|
||||||
Subtypes :class:`Real` and adds
|
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
|
should be in lowest terms. With these, it provides a default for
|
||||||
:func:`float`.
|
:func:`float`.
|
||||||
|
|
||||||
|
@ -74,8 +74,8 @@ The numeric tower
|
||||||
.. class:: Integral
|
.. class:: Integral
|
||||||
|
|
||||||
Subtypes :class:`Rational` and adds a conversion to :class:`int`.
|
Subtypes :class:`Rational` and adds a conversion to :class:`int`.
|
||||||
Provides defaults for :func:`float`, :attr:`Rational.numerator`, and
|
Provides defaults for :func:`float`, :attr:`~Rational.numerator`, and
|
||||||
:attr:`Rational.denominator`, and bit-string operations: ``<<``,
|
: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
|
knowledge of ``A``, so it can handle those instances before
|
||||||
delegating to :class:`Complex`.
|
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
|
then the appropriate shared operation is the one involving the built
|
||||||
in :class:`complex`, and both :meth:`__radd__` s land there, so ``a+b
|
in :class:`complex`, and both :meth:`__radd__` s land there, so ``a+b
|
||||||
== b+a``.
|
== b+a``.
|
||||||
|
|
|
@ -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::
|
while the long form uses an indented block and allows nested definitions::
|
||||||
|
|
||||||
def make_power(exp):
|
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):
|
def raiser(x, y=exp):
|
||||||
return x ** y
|
return x ** y
|
||||||
return raiser
|
return raiser
|
||||||
|
|
|
@ -207,7 +207,7 @@ An :class:`SMTP` instance has the following methods:
|
||||||
previous ``EHLO`` or ``HELO`` command this session. It tries ESMTP ``EHLO``
|
previous ``EHLO`` or ``HELO`` command this session. It tries ESMTP ``EHLO``
|
||||||
first.
|
first.
|
||||||
|
|
||||||
:exc:SMTPHeloError
|
:exc:`SMTPHeloError`
|
||||||
The server didn't reply properly to the ``HELO`` greeting.
|
The server didn't reply properly to the ``HELO`` greeting.
|
||||||
|
|
||||||
.. versionadded:: 2.6
|
.. versionadded:: 2.6
|
||||||
|
|
|
@ -290,7 +290,7 @@ described in those functions, as well as provide an additional method:
|
||||||
|
|
||||||
.. versionadded:: 2.5
|
.. 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
|
.. class:: BaseResult
|
||||||
|
|
|
@ -148,7 +148,7 @@ Positional and keyword arguments can be arbitrarily combined::
|
||||||
... other='Georg')
|
... other='Georg')
|
||||||
The story of Bill, Manfred, and 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
|
greater control over how the value is formatted. The following example
|
||||||
truncates the Pi to three places after the decimal.
|
truncates the Pi to three places after the decimal.
|
||||||
|
|
||||||
|
|
|
@ -404,7 +404,7 @@ These environment variables influence Python's behavior.
|
||||||
compiled form). Extension modules cannot be imported from zipfiles.
|
compiled form). Extension modules cannot be imported from zipfiles.
|
||||||
|
|
||||||
The default search path is installation dependent, but generally begins with
|
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`.
|
is *always* appended to :envvar:`PYTHONPATH`.
|
||||||
|
|
||||||
An additional directory will be inserted in the search path in front of
|
An additional directory will be inserted in the search path in front of
|
||||||
|
|
|
@ -1428,7 +1428,7 @@ Running the above function's tests with :const:`doctest.REPORT_UDIFF` specified,
|
||||||
you get the following output::
|
you get the following output::
|
||||||
|
|
||||||
**********************************************************************
|
**********************************************************************
|
||||||
File ``t.py'', line 15, in g
|
File "t.py", line 15, in g
|
||||||
Failed example:
|
Failed example:
|
||||||
g(4)
|
g(4)
|
||||||
Differences (unified diff with -expected +actual):
|
Differences (unified diff with -expected +actual):
|
||||||
|
|
|
@ -485,7 +485,7 @@ And here's an example of changing the counter::
|
||||||
9
|
9
|
||||||
>>> print it.next()
|
>>> print it.next()
|
||||||
Traceback (most recent call last):
|
Traceback (most recent call last):
|
||||||
File ``t.py'', line 15, in ?
|
File "t.py", line 15, in ?
|
||||||
print it.next()
|
print it.next()
|
||||||
StopIteration
|
StopIteration
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue