[Python-checkins] cpython (2.7): Issue #12947: Add a note to doctest until the example rendering is fixed

[nick.coghlan]

http://hg.python.org/cpython/rev/662fb4bd5f84
changeset:   79429:662fb4bd5f84
branch:      2.7
parent:      79419:2eaaa7b0e7a9
user:        Nick Coghlan <ncoghlan at gmail.com>
date:        Wed Oct 03 12:18:23 2012 +0530
summary:
  Issue #12947: Add a note to doctest until the example rendering is fixed

files:
  Doc/library/doctest.rst |  8 ++++++++
  1 files changed, 8 insertions(+), 0 deletions(-)


diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -680,6 +680,14 @@
 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

-- 
Repository URL: http://hg.python.org/cpython