summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Coghlan <ncoghlan@gmail.com>2012-10-03 12:18:23 +0530
committerNick Coghlan <ncoghlan@gmail.com>2012-10-03 12:18:23 +0530
commita42709e6bb30c6ecd8c4854ecf62fc83ab2854e3 (patch)
treeaccde1a24141c2abf79cdcce9ddceed72e57628d
parent364f79d7b3ee1ebd0a6312cb15f4aae231a66c4d (diff)
downloadcpython-git-a42709e6bb30c6ecd8c4854ecf62fc83ab2854e3.tar.gz
Issue #12947: Add a note to doctest until the example rendering is fixed
-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 a316558922..92d9a021d7 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -680,6 +680,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 range(20) #doctest: +NORMALIZE_WHITESPACE