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

[nick.coghlan]

http://hg.python.org/cpython/rev/679b3e3aadae
changeset:   79430:679b3e3aadae
branch:      3.3
parent:      79427:4906d2eb55ef
user:        Nick Coghlan <ncoghlan at gmail.com>
date:        Wed Oct 03 12:21:44 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
@@ -650,6 +650,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(list(range(20))) #doctest: +NORMALIZE_WHITESPACE

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