]> granicus.if.org Git - python/commitdiff
Issue #12947: Add a note to doctest until the example rendering is fixed
authorNick Coghlan <ncoghlan@gmail.com>
Wed, 3 Oct 2012 06:51:44 +0000 (12:21 +0530)
committerNick Coghlan <ncoghlan@gmail.com>
Wed, 3 Oct 2012 06:51:44 +0000 (12:21 +0530)
Doc/library/doctest.rst

index ed53f0605176f24208f759643da4129508eb49cf..351db5150a1d0b346b8fbd3648cfe54dab16d925 100644 (file)
@@ -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