summaryrefslogtreecommitdiffstats
path: root/Doc/library/doctest.rst
diff options
context:
space:
mode:
authorJulien Palard <julien@palard.fr>2021-01-25 14:46:06 (GMT)
committerGitHub <noreply@github.com>2021-01-25 14:46:06 (GMT)
commit5c1f15b4b1024cbf0acc85832f0c623d1a4605fd (patch)
tree557ba61e17c68c0e830ec6577e19b9d224f8572a /Doc/library/doctest.rst
parent483359174e92489e13959977824806734f1a8cdd (diff)
downloadcpython-5c1f15b4b1024cbf0acc85832f0c623d1a4605fd.zip
cpython-5c1f15b4b1024cbf0acc85832f0c623d1a4605fd.tar.gz
cpython-5c1f15b4b1024cbf0acc85832f0c623d1a4605fd.tar.bz2
bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)
Diffstat (limited to 'Doc/library/doctest.rst')
-rw-r--r--Doc/library/doctest.rst54
1 files changed, 17 insertions, 37 deletions
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index 42ad0c9..a77322f 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -719,51 +719,36 @@ above.
An example's doctest directives modify doctest's behavior for that single
example. Use ``+`` to enable the named behavior, or ``-`` to disable it.
-For example, this test passes:
+For example, this test passes::
-.. doctest::
- :no-trim-doctest-flags:
-
- >>> print(list(range(20))) # doctest: +NORMALIZE_WHITESPACE
+ >>> print(list(range(20))) # doctest: +NORMALIZE_WHITESPACE
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9,
10, 11, 12, 13, 14, 15, 16, 17, 18, 19]
Without the directive it would fail, both because the actual output doesn't have
two blanks before the single-digit list elements, and because the actual output
is on a single line. This test also passes, and also requires a directive to do
-so:
-
-.. doctest::
- :no-trim-doctest-flags:
+so::
- >>> print(list(range(20))) # doctest: +ELLIPSIS
+ >>> print(list(range(20))) # doctest: +ELLIPSIS
[0, 1, ..., 18, 19]
Multiple directives can be used on a single physical line, separated by
-commas:
+commas::
-.. doctest::
- :no-trim-doctest-flags:
-
- >>> print(list(range(20))) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
+ >>> print(list(range(20))) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
[0, 1, ..., 18, 19]
If multiple directive comments are used for a single example, then they are
-combined:
-
-.. doctest::
- :no-trim-doctest-flags:
+combined::
- >>> print(list(range(20))) # doctest: +ELLIPSIS
- ... # doctest: +NORMALIZE_WHITESPACE
+ >>> print(list(range(20))) # doctest: +ELLIPSIS
+ ... # doctest: +NORMALIZE_WHITESPACE
[0, 1, ..., 18, 19]
As the previous example shows, you can add ``...`` lines to your example
containing only directives. This can be useful when an example is too long for
-a directive to comfortably fit on the same line:
-
-.. doctest::
- :no-trim-doctest-flags:
+a directive to comfortably fit on the same line::
>>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40)))
... # doctest: +ELLIPSIS
@@ -808,23 +793,18 @@ instead. Another is to do ::
There are others, but you get the idea.
-Another bad idea is to print things that embed an object address, like
-
-.. doctest::
+Another bad idea is to print things that embed an object address, like ::
- >>> id(1.0) # certain to fail some of the time # doctest: +SKIP
+ >>> id(1.0) # certain to fail some of the time
7948648
>>> class C: pass
- >>> C() # the default repr() for instances embeds an address # doctest: +SKIP
- <C object at 0x00AC18F0>
-
-The :const:`ELLIPSIS` directive gives a nice approach for the last example:
+ >>> C() # the default repr() for instances embeds an address
+ <__main__.C instance at 0x00AC18F0>
-.. doctest::
- :no-trim-doctest-flags:
+The :const:`ELLIPSIS` directive gives a nice approach for the last example::
- >>> C() # doctest: +ELLIPSIS
- <C object at 0x...>
+ >>> C() #doctest: +ELLIPSIS
+ <__main__.C instance at 0x...>
Floating-point numbers are also subject to small output variations across
platforms, because Python defers to the platform C library for float formatting,