summaryrefslogtreecommitdiffstats
path: root/Doc/library/doctest.rst
diff options
context:
space:
mode:
authorNick Coghlan <ncoghlan@gmail.com>2012-10-03 06:51:44 (GMT)
committerNick Coghlan <ncoghlan@gmail.com>2012-10-03 06:51:44 (GMT)
commit8f80e0a6515e7a0446c228ac982f0a876971bdc3 (patch)
treedd23c8e3b8ae4b32729ad56e42cfbc293eab07e4 /Doc/library/doctest.rst
parent22ab5e7640490f35d40d7d1a1723616e727132b8 (diff)
downloadcpython-8f80e0a6515e7a0446c228ac982f0a876971bdc3.zip
cpython-8f80e0a6515e7a0446c228ac982f0a876971bdc3.tar.gz
cpython-8f80e0a6515e7a0446c228ac982f0a876971bdc3.tar.bz2
Issue #12947: Add a note to doctest until the example rendering is fixed
Diffstat (limited to 'Doc/library/doctest.rst')
-rw-r--r--Doc/library/doctest.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index ed53f06..351db51 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -650,6 +650,14 @@ above.
An example's doctest directives modify doctest's behavior for that single
example. Use ``+`` to enable the named behavior, or ``-`` to disable it.
+.. note::
+ Due to an `unfortunate bug`_ in our documentation publishing process, the
+ directives in the following examples are not being displayed in the
+ rendered HTML version. Please use the "Show Source" link in the sidebar
+ to view the details of the directive usage examples.
+
+ .. _unfortunate bug: http://bugs.python.org/issue12947
+
For example, this test passes::
>>> print(list(range(20))) #doctest: +NORMALIZE_WHITESPACE