From: Nick Coghlan <ncoghlan@gmail.com>
Date: Wed, 3 Oct 2012 06:48:23 +0000 (+0530)
Subject: Issue #12947: Add a note to doctest until the example rendering is fixed
X-Git-Tag: v2.7.4rc1~516
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a42709e6bb30c6ecd8c4854ecf62fc83ab2854e3;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 a31655892221..92d9a021d77e 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