Fix suspicious markup in the docs.

This commit is contained in:
Georg Brandl 2013-11-24 16:09:26 +01:00
parent 163d7f02a1
commit ed007d5b1b
7 changed files with 22 additions and 20 deletions

View file

@ -96,7 +96,7 @@ this module.
only it when looking for candidate matches. Otherwise consider only the only it when looking for candidate matches. Otherwise consider only the
first (default root) part of the ``multipart/related``. first (default root) part of the ``multipart/related``.
If a part has a :mailheader:``Content-Disposition`` header, only consider If a part has a :mailheader:`Content-Disposition` header, only consider
the part a candidate match if the value of the header is ``inline``. the part a candidate match if the value of the header is ``inline``.
If none of the candidates matches any of the preferences in If none of the candidates matches any of the preferences in
@ -134,7 +134,7 @@ this module.
Return an iterator over all of the immediate sub-parts of the message, Return an iterator over all of the immediate sub-parts of the message,
which will be empty for a non-``multipart``. (See also which will be empty for a non-``multipart``. (See also
:meth:``~email.message.walk``.) :meth:`~email.message.walk`.)
.. method:: get_content(*args, content_manager=None, **kw) .. method:: get_content(*args, content_manager=None, **kw)

View file

@ -35,7 +35,7 @@ Here are the methods of the :class:`Message` class:
If *policy* is specified (it must be an instance of a :mod:`~email.policy` If *policy* is specified (it must be an instance of a :mod:`~email.policy`
class) use the rules it specifies to udpate and serialize the representation class) use the rules it specifies to udpate and serialize the representation
of the message. If *policy* is not set, use the :class`compat32 of the message. If *policy* is not set, use the :class:`compat32
<email.policy.Compat32>` policy, which maintains backward compatibility with <email.policy.Compat32>` policy, which maintains backward compatibility with
the Python 3.2 version of the email package. For more information see the the Python 3.2 version of the email package. For more information see the
:mod:`~email.policy` documentation. :mod:`~email.policy` documentation.

View file

@ -476,9 +476,9 @@ applications.)
:program:`xgettext`, :program:`pygettext`, and similar tools generate :program:`xgettext`, :program:`pygettext`, and similar tools generate
:file:`.po` files that are message catalogs. They are structured :file:`.po` files that are message catalogs. They are structured
:human-readable files that contain every marked string in the source human-readable files that contain every marked string in the source
:code, along with a placeholder for the translated versions of these code, along with a placeholder for the translated versions of these
:strings. strings.
Copies of these :file:`.po` files are then handed over to the Copies of these :file:`.po` files are then handed over to the
individual human translators who write translations for every individual human translators who write translations for every

View file

@ -901,8 +901,8 @@ Test cases
| :meth:`assertWarnsRegex(warn, r, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *warn* | 3.2 | | :meth:`assertWarnsRegex(warn, r, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *warn* | 3.2 |
| <TestCase.assertWarnsRegex>` | and the message matches regex *r* | | | <TestCase.assertWarnsRegex>` | and the message matches regex *r* | |
+---------------------------------------------------------+--------------------------------------+------------+ +---------------------------------------------------------+--------------------------------------+------------+
| :meth:`assertLogs(logger, level)` | The ``with`` block logs on *logger* | 3.4 | | :meth:`assertLogs(logger, level) | The ``with`` block logs on *logger* | 3.4 |
| <TestCase.assertWarns>` | with minimum *level* | | | <TestCase.assertLogs>` | with minimum *level* | |
+---------------------------------------------------------+--------------------------------------+------------+ +---------------------------------------------------------+--------------------------------------+------------+
.. method:: assertRaises(exception, callable, *args, **kwds) .. method:: assertRaises(exception, callable, *args, **kwds)

View file

@ -141,15 +141,8 @@ library/linecache,,:sys,"sys:x:3:3:sys:/dev:/bin/sh"
library/logging.handlers,,:port,host:port library/logging.handlers,,:port,host:port
library/mmap,,:i2,obj[i1:i2] library/mmap,,:i2,obj[i1:i2]
library/multiprocessing,,`,# Add more tasks using `put()` library/multiprocessing,,`,# Add more tasks using `put()`
library/multiprocessing,,`,# A test file for the `multiprocessing` package
library/multiprocessing,,`,# A test of `multiprocessing.Pool` class
library/multiprocessing,,`,# `BaseManager`.
library/multiprocessing,,`,# in the original order then consider using `Pool.map()` or
library/multiprocessing,,`,">>> l._callmethod('__getitem__', (20,)) # equiv to `l[20]`" library/multiprocessing,,`,">>> l._callmethod('__getitem__', (20,)) # equiv to `l[20]`"
library/multiprocessing,,`,">>> l._callmethod('__getslice__', (2, 7)) # equiv to `l[2:7]`" library/multiprocessing,,`,">>> l._callmethod('__getslice__', (2, 7)) # equiv to `l[2:7]`"
library/multiprocessing,,`,# Not sure if we should synchronize access to `socket.accept()` method by
library/multiprocessing,,`,# object. (We import `multiprocessing.reduction` to enable this pickling.)
library/multiprocessing,,`,# `Pool.imap()` (which will save on the amount of code needed anyway).
library/multiprocessing,,:queue,">>> QueueManager.register('get_queue', callable=lambda:queue)" library/multiprocessing,,:queue,">>> QueueManager.register('get_queue', callable=lambda:queue)"
library/multiprocessing,,`,# register the Foo class; make `f()` and `g()` accessible via proxy library/multiprocessing,,`,# register the Foo class; make `f()` and `g()` accessible via proxy
library/multiprocessing,,`,# register the Foo class; make `g()` and `_h()` accessible via proxy library/multiprocessing,,`,# register the Foo class; make `g()` and `_h()` accessible via proxy
@ -158,6 +151,10 @@ library/nntplib,,:bytes,:bytes
library/nntplib,,:lines,:lines library/nntplib,,:lines,:lines
library/optparse,,:len,"del parser.rargs[:len(value)]" library/optparse,,:len,"del parser.rargs[:len(value)]"
library/os.path,,:foo,c:foo library/os.path,,:foo,c:foo
library/pathlib,,:bar,">>> PureWindowsPath('c:/Windows', 'd:bar')"
library/pathlib,,:bar,PureWindowsPath('d:bar')
library/pathlib,,:Program,>>> PureWindowsPath('c:Program Files/').root
library/pathlib,,:Program,>>> PureWindowsPath('c:Program Files/').anchor
library/pdb,,:lineno,filename:lineno library/pdb,,:lineno,filename:lineno
library/pickle,,:memory,"conn = sqlite3.connect("":memory:"")" library/pickle,,:memory,"conn = sqlite3.connect("":memory:"")"
library/posix,,`,"CFLAGS=""`getconf LFS_CFLAGS`"" OPT=""-g -O2 $CFLAGS""" library/posix,,`,"CFLAGS=""`getconf LFS_CFLAGS`"" OPT=""-g -O2 $CFLAGS"""
@ -200,7 +197,12 @@ library/tarfile,,:xz,'r:xz'
library/tarfile,,:xz,'w:xz' library/tarfile,,:xz,'w:xz'
library/time,,:mm, library/time,,:mm,
library/time,,:ss, library/time,,:ss,
library/tracemalloc,,:limit,"for index, stat in enumerate(top_stats[:limit], 1):"
library/turtle,,::,Example:: library/turtle,,::,Example::
library/unittest,1412,:foo,"self.assertEqual(cm.output, ['INFO:foo:first message',"
library/unittest,1412,:first,"self.assertEqual(cm.output, ['INFO:foo:first message',"
library/unittest,1412,:foo,'ERROR:foo.bar:second message'])
library/unittest,1412,:second,'ERROR:foo.bar:second message'])
library/urllib.request,,:close,Connection:close library/urllib.request,,:close,Connection:close
library/urllib.request,,:lang,"xmlns=""http://www.w3.org/1999/xhtml"" xml:lang=""en"" lang=""en"">\n\n<head>\n" library/urllib.request,,:lang,"xmlns=""http://www.w3.org/1999/xhtml"" xml:lang=""en"" lang=""en"">\n\n<head>\n"
library/urllib.request,,:password,"""joe:password@python.org""" library/urllib.request,,:password,"""joe:password@python.org"""

1 c-api/arg :ref PyArg_ParseTuple(args, "O|O:ref", &object, &callback)
141 library/logging.handlers :port host:port
142 library/mmap :i2 obj[i1:i2]
143 library/multiprocessing ` # Add more tasks using `put()`
library/multiprocessing ` # A test file for the `multiprocessing` package
library/multiprocessing ` # A test of `multiprocessing.Pool` class
library/multiprocessing ` # `BaseManager`.
library/multiprocessing ` # in the original order then consider using `Pool.map()` or
144 library/multiprocessing ` >>> l._callmethod('__getitem__', (20,)) # equiv to `l[20]`
145 library/multiprocessing ` >>> l._callmethod('__getslice__', (2, 7)) # equiv to `l[2:7]`
library/multiprocessing ` # Not sure if we should synchronize access to `socket.accept()` method by
library/multiprocessing ` # object. (We import `multiprocessing.reduction` to enable this pickling.)
library/multiprocessing ` # `Pool.imap()` (which will save on the amount of code needed anyway).
146 library/multiprocessing :queue >>> QueueManager.register('get_queue', callable=lambda:queue)
147 library/multiprocessing ` # register the Foo class; make `f()` and `g()` accessible via proxy
148 library/multiprocessing ` # register the Foo class; make `g()` and `_h()` accessible via proxy
151 library/nntplib :lines :lines
152 library/optparse :len del parser.rargs[:len(value)]
153 library/os.path :foo c:foo
154 library/pathlib :bar >>> PureWindowsPath('c:/Windows', 'd:bar')
155 library/pathlib :bar PureWindowsPath('d:bar')
156 library/pathlib :Program >>> PureWindowsPath('c:Program Files/').root
157 library/pathlib :Program >>> PureWindowsPath('c:Program Files/').anchor
158 library/pdb :lineno filename:lineno
159 library/pickle :memory conn = sqlite3.connect(":memory:")
160 library/posix ` CFLAGS="`getconf LFS_CFLAGS`" OPT="-g -O2 $CFLAGS"
197 library/tarfile :xz 'w:xz'
198 library/time :mm
199 library/time :ss
200 library/tracemalloc :limit for index, stat in enumerate(top_stats[:limit], 1):
201 library/turtle :: Example::
202 library/unittest 1412 :foo self.assertEqual(cm.output, ['INFO:foo:first message',
203 library/unittest 1412 :first self.assertEqual(cm.output, ['INFO:foo:first message',
204 library/unittest 1412 :foo 'ERROR:foo.bar:second message'])
205 library/unittest 1412 :second 'ERROR:foo.bar:second message'])
206 library/urllib.request :close Connection:close
207 library/urllib.request :lang xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n\n<head>\n
208 library/urllib.request :password "joe:password@python.org"

View file

@ -424,7 +424,7 @@ base64
The encoding and decoding functions in :mod:`base64` now accept any The encoding and decoding functions in :mod:`base64` now accept any
:term:`bytes-like object` in cases where it previously required a :term:`bytes-like object` in cases where it previously required a
:class:`bytes` or :class:`bytearray` instance (:issue`17839`) :class:`bytes` or :class:`bytearray` instance (:issue:`17839`).
colorsys colorsys

View file

@ -2518,7 +2518,7 @@ Library
- Issue #14398: Fix size truncation and overflow bugs in the bz2 module. - Issue #14398: Fix size truncation and overflow bugs in the bz2 module.
- Issue #12692: Fix resource leak in urllib.request when talking to an HTTP - Issue #12692: Fix resource leak in urllib.request when talking to an HTTP
server that does not include a "Connection: close" header in its responses. server that does not include a ``Connection: close`` header in its responses.
- Issue #12034: Fix bogus caching of result in check_GetFinalPathNameByHandle. - Issue #12034: Fix bogus caching of result in check_GetFinalPathNameByHandle.
Patch by Atsuo Ishimoto. Patch by Atsuo Ishimoto.
@ -6091,7 +6091,7 @@ Library
given as a low fd, it gets overwritten. given as a low fd, it gets overwritten.
- Issue #12576: Fix urlopen behavior on sites which do not send (or obfuscates) - Issue #12576: Fix urlopen behavior on sites which do not send (or obfuscates)
Connection:close header. ``Connection: close`` header.
- Issue #12560: Build libpython.so on OpenBSD. Patch by Stefan Sperling. - Issue #12560: Build libpython.so on OpenBSD. Patch by Stefan Sperling.
@ -6686,7 +6686,7 @@ Library
- Issue #11127: Raise a TypeError when trying to pickle a socket object. - Issue #11127: Raise a TypeError when trying to pickle a socket object.
- Issue #11563: Connection:close header is sent by requests using URLOpener - Issue #11563: ``Connection: close`` header is sent by requests using URLOpener
class which helps in closing of sockets after connection is over. Patch class which helps in closing of sockets after connection is over. Patch
contributions by Jeff McNeil and Nadeem Vawda. contributions by Jeff McNeil and Nadeem Vawda.
@ -7262,7 +7262,7 @@ Tests
- Issue #11505: improves test coverage of string.py. Patch by Alicia - Issue #11505: improves test coverage of string.py. Patch by Alicia
Arlen Arlen
- Issue #11490: test_subprocess:test_leaking_fds_on_error no longer gives a - Issue #11490: test_subprocess.test_leaking_fds_on_error no longer gives a
false positive if the last directory in the path is inaccessible. false positive if the last directory in the path is inaccessible.
- Issue #11223: Fix test_threadsignals to fail, not hang, when the - Issue #11223: Fix test_threadsignals to fail, not hang, when the