From: Nick Coghlan <ncoghlan@gmail.com>
Date: Wed, 3 Oct 2012 06:51:44 +0000 (+0530)
Subject: Issue #12947: Add a note to doctest until the example rendering is fixed
X-Git-Tag: v3.4.0a1~2395^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8f80e0a6515e7a0446c228ac982f0a876971bdc3;p=thirdparty%2FPython%2Fcpython.git

Issue #12947: Add a note to doctest until the example rendering is fixed
---

diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index ed53f0605176..351db5150a1d 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