[Python-checkins] cpython: Fix suspicious markup in the docs.
georg.brandl
python-checkins at python.org
Sun Nov 24 16:11:26 CET 2013
http://hg.python.org/cpython/rev/f99e67cdedfb
changeset: 87506:f99e67cdedfb
user: Georg Brandl <georg at python.org>
date: Sun Nov 24 16:09:26 2013 +0100
summary:
Fix suspicious markup in the docs.
files:
Doc/library/email.contentmanager.rst | 4 ++--
Doc/library/email.message.rst | 2 +-
Doc/library/gettext.rst | 6 +++---
Doc/library/unittest.rst | 4 ++--
Doc/tools/sphinxext/susp-ignored.csv | 16 +++++++++-------
Doc/whatsnew/3.4.rst | 2 +-
Misc/NEWS | 8 ++++----
7 files changed, 22 insertions(+), 20 deletions(-)
diff --git a/Doc/library/email.contentmanager.rst b/Doc/library/email.contentmanager.rst
--- a/Doc/library/email.contentmanager.rst
+++ b/Doc/library/email.contentmanager.rst
@@ -96,7 +96,7 @@
only it when looking for candidate matches. Otherwise consider only the
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``.
If none of the candidates matches any of the preferences in
@@ -134,7 +134,7 @@
Return an iterator over all of the immediate sub-parts of the message,
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)
diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst
--- a/Doc/library/email.message.rst
+++ b/Doc/library/email.message.rst
@@ -35,7 +35,7 @@
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
- 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
the Python 3.2 version of the email package. For more information see the
:mod:`~email.policy` documentation.
diff --git a/Doc/library/gettext.rst b/Doc/library/gettext.rst
--- a/Doc/library/gettext.rst
+++ b/Doc/library/gettext.rst
@@ -476,9 +476,9 @@
:program:`xgettext`, :program:`pygettext`, and similar tools generate
:file:`.po` files that are message catalogs. They are structured
-:human-readable files that contain every marked string in the source
-:code, along with a placeholder for the translated versions of these
-:strings.
+human-readable files that contain every marked string in the source
+code, along with a placeholder for the translated versions of these
+strings.
Copies of these :file:`.po` files are then handed over to the
individual human translators who write translations for every
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -901,8 +901,8 @@
| :meth:`assertWarnsRegex(warn, r, fun, *args, **kwds) | ``fun(*args, **kwds)`` raises *warn* | 3.2 |
| <TestCase.assertWarnsRegex>` | and the message matches regex *r* | |
+---------------------------------------------------------+--------------------------------------+------------+
- | :meth:`assertLogs(logger, level)` | The ``with`` block logs on *logger* | 3.4 |
- | <TestCase.assertWarns>` | with minimum *level* | |
+ | :meth:`assertLogs(logger, level) | The ``with`` block logs on *logger* | 3.4 |
+ | <TestCase.assertLogs>` | with minimum *level* | |
+---------------------------------------------------------+--------------------------------------+------------+
.. method:: assertRaises(exception, callable, *args, **kwds)
diff --git a/Doc/tools/sphinxext/susp-ignored.csv b/Doc/tools/sphinxext/susp-ignored.csv
--- a/Doc/tools/sphinxext/susp-ignored.csv
+++ b/Doc/tools/sphinxext/susp-ignored.csv
@@ -141,15 +141,8 @@
library/logging.handlers,,:port,host:port
library/mmap,,:i2,obj[i1:i2]
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('__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,,`,# register the Foo class; make `f()` and `g()` accessible via proxy
library/multiprocessing,,`,# register the Foo class; make `g()` and `_h()` accessible via proxy
@@ -158,6 +151,10 @@
library/nntplib,,:lines,:lines
library/optparse,,:len,"del parser.rargs[:len(value)]"
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/pickle,,:memory,"conn = sqlite3.connect("":memory:"")"
library/posix,,`,"CFLAGS=""`getconf LFS_CFLAGS`"" OPT=""-g -O2 $CFLAGS"""
@@ -200,7 +197,12 @@
library/tarfile,,:xz,'w:xz'
library/time,,:mm,
library/time,,:ss,
+library/tracemalloc,,:limit,"for index, stat in enumerate(top_stats[:limit], 1):"
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,,:lang,"xmlns=""http://www.w3.org/1999/xhtml"" xml:lang=""en"" lang=""en"">\n\n<head>\n"
library/urllib.request,,:password,"""joe:password at python.org"""
diff --git a/Doc/whatsnew/3.4.rst b/Doc/whatsnew/3.4.rst
--- a/Doc/whatsnew/3.4.rst
+++ b/Doc/whatsnew/3.4.rst
@@ -424,7 +424,7 @@
The encoding and decoding functions in :mod:`base64` now accept any
: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
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -2518,7 +2518,7 @@
- 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
- 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.
Patch by Atsuo Ishimoto.
@@ -6091,7 +6091,7 @@
given as a low fd, it gets overwritten.
- 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.
@@ -6686,7 +6686,7 @@
- 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
contributions by Jeff McNeil and Nadeem Vawda.
@@ -7262,7 +7262,7 @@
- Issue #11505: improves test coverage of string.py. Patch by Alicia
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.
- Issue #11223: Fix test_threadsignals to fail, not hang, when the
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list