Skip to content

Commit 7d2d3b6

Browse files
author
georg.brandl
committedJan 2, 2009
#4811: fix markup glitches (mostly remains of the conversion),
found by Gabriel Genellina. git-svn-id: http://svn.python.org/projects/python/trunk@68171 6015fed2-1504-0410-9fe1-9d1591cc4771
1 parent 0569ad2 commit 7d2d3b6

19 files changed

+42
-39
lines changed
 

‎Doc/ACKS.txt

+1
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ docs@python.org), and we'll be glad to correct the problem.
6060
* Peter Funk
6161
* Lele Gaifax
6262
* Matthew Gallagher
63+
* Gabriel Genellina
6364
* Ben Gertzfield
6465
* Nadim Ghaznavi
6566
* Jonathan Giddy

‎Doc/c-api/arg.rst

+7-6
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ variable(s) whose address should be passed.
4646
:ctype:`Py_ssize_t` rather than an int.
4747

4848
``s*`` (string, Unicode, or any buffer compatible object) [Py_buffer \*]
49-
Similar to ``s#``, this code fills a Py_buffer structure provided by the caller.
50-
The buffer gets locked, so that the caller can subsequently use the buffer even
51-
inside a ``Py_BEGIN_ALLOW_THREADS`` block; the caller is responsible for calling
52-
``PyBuffer_Release`` with the structure after it has processed the data.
49+
Similar to ``s#``, this code fills a Py_buffer structure provided by the caller.
50+
The buffer gets locked, so that the caller can subsequently use the buffer even
51+
inside a ``Py_BEGIN_ALLOW_THREADS`` block; the caller is responsible for calling
52+
``PyBuffer_Release`` with the structure after it has processed the data.
5353

54-
.. versionadded:: 2.6
54+
.. versionadded:: 2.6
5555

5656
``z`` (string or ``None``) [const char \*]
5757
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.
6363
``z*`` (string or ``None`` or any buffer compatible object) [Py_buffer*]
6464
This is to ``s*`` as ``z`` is to ``s``.
6565

66-
.. versionadded:: 2.6
66+
.. versionadded:: 2.6
6767

6868
``u`` (Unicode object) [Py_UNICODE \*]
6969
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.
261261

262262
``w*`` (read-write byte-oriented buffer) [Py_buffer \*]
263263
This is to ``w`` what ``s*`` is to ``s``.
264+
264265
.. versionadded:: 2.6
265266

266267
``(items)`` (tuple) [*matching-items*]

‎Doc/distutils/apiref.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -188,9 +188,10 @@ the full reference.
188188
| | for C/C++ header files (in | |
189189
| | Unix form for portability) | |
190190
+------------------------+--------------------------------+---------------------------+
191-
| *define_macros* | list of macros to define; each | (string,string) tuple or |
192-
| | macro is defined using a | (name,``None``) |
193-
| | 2-tuple, where 'value' is | |
191+
| *define_macros* | list of macros to define; each | (string, string) tuple or |
192+
| | macro is defined using a | (name, ``None``) |
193+
| | 2-tuple ``(name, value)``, | |
194+
| | where *value* is | |
194195
| | either the string to define it | |
195196
| | to or ``None`` to define it | |
196197
| | without a particular value | |

‎Doc/howto/functional.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,7 @@ And here's an example of changing the counter:
585585
9
586586
>>> print it.next()
587587
Traceback (most recent call last):
588-
File ``t.py'', line 15, in ?
588+
File "t.py", line 15, in ?
589589
print it.next()
590590
StopIteration
591591

‎Doc/howto/urllib2.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ than the URL you pass to .add_password() will also match. ::
470470
password_mgr = urllib2.HTTPPasswordMgrWithDefaultRealm()
471471

472472
# Add the username and password.
473-
# If we knew the realm, we could use it instead of ``None``.
473+
# If we knew the realm, we could use it instead of None.
474474
top_level_url = "http://example.com/foo/"
475475
password_mgr.add_password(None, top_level_url, username, password)
476476

‎Doc/install/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,7 @@ value of ``sys.path``. ::
587587
$ python
588588
Python 2.2 (#11, Oct 3 2002, 13:31:27)
589589
[GCC 2.96 20000731 (Red Hat Linux 7.3 2.96-112)] on linux2
590-
Type ``help'', ``copyright'', ``credits'' or ``license'' for more information.
590+
Type "help", "copyright", "credits" or "license" for more information.
591591
>>> import sys
592592
>>> sys.path
593593
['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2',

‎Doc/library/cookielib.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -733,7 +733,7 @@ accessed using the following methods:
733733
The :class:`Cookie` class also defines the following method:
734734

735735

736-
.. method:: Cookie.is_expired([now=:const:`None`])
736+
.. method:: Cookie.is_expired([now=None])
737737

738738
True if cookie has passed the time at which the server requested it should
739739
expire. If *now* is given (in seconds since the epoch), return whether the

‎Doc/library/email.mime.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,14 @@ Here are the classes:
5757

5858
.. currentmodule:: email.mime.multipart
5959

60-
.. class:: MIMEMultipart([subtype[, boundary[, _subparts[, _params]]]])
60+
.. class:: MIMEMultipart([_subtype[, boundary[, _subparts[, _params]]]])
6161

6262
Module: :mod:`email.mime.multipart`
6363

6464
A subclass of :class:`MIMEBase`, this is an intermediate base class for MIME
6565
messages that are :mimetype:`multipart`. Optional *_subtype* defaults to
6666
:mimetype:`mixed`, but can be used to specify the subtype of the message. A
67-
:mailheader:`Content-Type` header of :mimetype:`multipart/`*_subtype* will be
67+
:mailheader:`Content-Type` header of :mimetype:`multipart/_subtype` will be
6868
added to the message object. A :mailheader:`MIME-Version` header will also be
6969
added.
7070

‎Doc/library/gzip.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
This module provides a simple interface to compress and decompress files just
88
like the GNU programs :program:`gzip` and :program:`gunzip` would.
99

10-
The data compression is provided by the :mod:``zlib`` module.
10+
The data compression is provided by the :mod:`zlib` module.
1111

1212
The :mod:`gzip` module provides the :class:`GzipFile` class which is modeled
1313
after Python's File Object. The :class:`GzipFile` class reads and writes

‎Doc/library/json.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Basic Usage
152152
*default(obj)* is a function that should return a serializable version of
153153
*obj* or raise :exc:`TypeError`. The default simply raises :exc:`TypeError`.
154154

155-
To use a custom :class:`JSONEncoder`` subclass (e.g. one that overrides the
155+
To use a custom :class:`JSONEncoder` subclass (e.g. one that overrides the
156156
:meth:`default` method to serialize additional types), specify it with the
157157
*cls* kwarg.
158158

‎Doc/library/multiprocessing.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -1138,18 +1138,18 @@ their parent process exits. The manager classes are defined in the
11381138

11391139
Returns a :class:`Server` object which represents the actual server under
11401140
the control of the Manager. The :class:`Server` object supports the
1141-
:meth:`serve_forever` method::
1141+
:meth:`serve_forever` method:
11421142

1143-
>>> from multiprocessing.managers import BaseManager
1144-
>>> m = BaseManager(address=('', 50000), authkey='abc'))
1145-
>>> server = m.get_server()
1146-
>>> s.serve_forever()
1143+
>>> from multiprocessing.managers import BaseManager
1144+
>>> m = BaseManager(address=('', 50000), authkey='abc'))
1145+
>>> server = m.get_server()
1146+
>>> s.serve_forever()
11471147

1148-
:class:`Server` additionally have an :attr:`address` attribute.
1148+
:class:`Server` additionally have an :attr:`address` attribute.
11491149

11501150
.. method:: connect()
11511151

1152-
Connect a local manager object to a remote manager process::
1152+
Connect a local manager object to a remote manager process:
11531153

11541154
>>> from multiprocessing.managers import BaseManager
11551155
>>> m = BaseManager(address='127.0.0.1', authkey='abc))
@@ -1295,7 +1295,7 @@ Customized managers
12951295
>>>>>>>>>>>>>>>>>>>
12961296

12971297
To create one's own manager, one creates a subclass of :class:`BaseManager` and
1298-
use the :meth:`~BaseManager.resgister` classmethod to register new types or
1298+
use the :meth:`~BaseManager.register` classmethod to register new types or
12991299
callables with the manager class. For example::
13001300

13011301
from multiprocessing.managers import BaseManager
@@ -1811,7 +1811,7 @@ Address Formats
18111811

18121812
* An ``'AF_PIPE'`` address is a string of the form
18131813
:samp:`r'\\\\.\\pipe\\{PipeName}'`. To use :func:`Client` to connect to a named
1814-
pipe on a remote computer called ServerName* one should use an address of the
1814+
pipe on a remote computer called *ServerName* one should use an address of the
18151815
form :samp:`r'\\\\{ServerName}\\pipe\\{PipeName}'`` instead.
18161816

18171817
Note that any string beginning with two backslashes is assumed by default to be

‎Doc/library/numbers.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,14 @@ The numeric tower
5151
:func:`round`, :func:`math.floor`, :func:`math.ceil`, :func:`divmod`, ``//``,
5252
``%``, ``<``, ``<=``, ``>``, and ``>=``.
5353

54-
Real also provides defaults for :func:`complex`, :attr:`Complex.real`,
55-
:attr:`Complex.imag`, and :meth:`Complex.conjugate`.
54+
Real also provides defaults for :func:`complex`, :attr:`~Complex.real`,
55+
:attr:`~Complex.imag`, and :meth:`~Complex.conjugate`.
5656

5757

5858
.. class:: Rational
5959

6060
Subtypes :class:`Real` and adds
61-
:attr:`Rational.numerator` and :attr:`Rational.denominator` properties, which
61+
:attr:`~Rational.numerator` and :attr:`~Rational.denominator` properties, which
6262
should be in lowest terms. With these, it provides a default for
6363
:func:`float`.
6464

@@ -74,8 +74,8 @@ The numeric tower
7474
.. class:: Integral
7575

7676
Subtypes :class:`Rational` and adds a conversion to :class:`int`.
77-
Provides defaults for :func:`float`, :attr:`Rational.numerator`, and
78-
:attr:`Rational.denominator`, and bit-string operations: ``<<``,
77+
Provides defaults for :func:`float`, :attr:`~Rational.numerator`, and
78+
:attr:`~Rational.denominator`, and bit-string operations: ``<<``,
7979
``>>``, ``&``, ``^``, ``|``, ``~``.
8080

8181

@@ -171,7 +171,7 @@ Complex``. I'll consider ``a + b``:
171171
knowledge of ``A``, so it can handle those instances before
172172
delegating to :class:`Complex`.
173173

174-
If ``A<:Complex`` and ``B<:Real`` without sharing any other knowledge,
174+
If ``A <: Complex`` and ``B <: Real`` without sharing any other knowledge,
175175
then the appropriate shared operation is the one involving the built
176176
in :class:`complex`, and both :meth:`__radd__` s land there, so ``a+b
177177
== b+a``.

‎Doc/library/parser.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ on the same line as the definition of the code block, as in ::
641641
while the long form uses an indented block and allows nested definitions::
642642

643643
def make_power(exp):
644-
"Make a function that raises an argument to the exponent `exp'."
644+
"Make a function that raises an argument to the exponent `exp`."
645645
def raiser(x, y=exp):
646646
return x ** y
647647
return raiser

‎Doc/library/smtplib.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ An :class:`SMTP` instance has the following methods:
207207
previous ``EHLO`` or ``HELO`` command this session. It tries ESMTP ``EHLO``
208208
first.
209209

210-
:exc:SMTPHeloError
210+
:exc:`SMTPHeloError`
211211
The server didn't reply properly to the ``HELO`` greeting.
212212

213213
.. versionadded:: 2.6

‎Doc/library/urlparse.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ described in those functions, as well as provide an additional method:
290290

291291
.. versionadded:: 2.5
292292

293-
The following classes provide the implementations of the parse results::
293+
The following classes provide the implementations of the parse results:
294294

295295

296296
.. class:: BaseResult

‎Doc/tutorial/inputoutput.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Positional and keyword arguments can be arbitrarily combined::
148148
... other='Georg')
149149
The story of Bill, Manfred, and Georg.
150150

151-
An optional ``':``` and format specifier can follow the field name. This also
151+
An optional ``':'`` and format specifier can follow the field name. This also
152152
greater control over how the value is formatted. The following example
153153
truncates the Pi to three places after the decimal.
154154

‎Doc/using/cmdline.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ These environment variables influence Python's behavior.
404404
compiled form). Extension modules cannot be imported from zipfiles.
405405

406406
The default search path is installation dependent, but generally begins with
407-
:file:`{prefix}/lib/python{version}`` (see :envvar:`PYTHONHOME` above). It
407+
:file:`{prefix}/lib/python{version}` (see :envvar:`PYTHONHOME` above). It
408408
is *always* appended to :envvar:`PYTHONPATH`.
409409

410410
An additional directory will be inserted in the search path in front of

‎Doc/whatsnew/2.4.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1428,7 +1428,7 @@ Running the above function's tests with :const:`doctest.REPORT_UDIFF` specified,
14281428
you get the following output::
14291429

14301430
**********************************************************************
1431-
File ``t.py'', line 15, in g
1431+
File "t.py", line 15, in g
14321432
Failed example:
14331433
g(4)
14341434
Differences (unified diff with -expected +actual):

‎Doc/whatsnew/2.5.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -485,7 +485,7 @@ And here's an example of changing the counter::
485485
9
486486
>>> print it.next()
487487
Traceback (most recent call last):
488-
File ``t.py'', line 15, in ?
488+
File "t.py", line 15, in ?
489489
print it.next()
490490
StopIteration
491491

0 commit comments

Comments
 (0)
Please sign in to comment.