Skip to content

Commit 882b942

Browse files
committed
Revert "bpo-36675: Doc: Reveal doctest directives (pythonGH-23620)"
This reverts commit c8a10d2.
1 parent 325e913 commit 882b942

File tree

2 files changed

+19
-39
lines changed

2 files changed

+19
-39
lines changed

.azure-pipelines/docs-steps.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ steps:
1212
inputs:
1313
versionSpec: '>=3.6'
1414

15-
- script: python -m pip install sphinx==3.2.1 blurb python-docs-theme
15+
- script: python -m pip install sphinx==2.2.0 blurb python-docs-theme
1616
displayName: 'Install build dependencies'
1717

1818
- ${{ if ne(parameters.latex, 'true') }}:
@@ -31,7 +31,7 @@ steps:
3131
- ${{ if eq(parameters.upload, 'true') }}:
3232
- task: PublishBuildArtifacts@1
3333
displayName: 'Publish docs'
34-
34+
3535
inputs:
3636
PathToPublish: '$(build.sourcesDirectory)/Doc/build'
3737
ArtifactName: docs

Doc/library/doctest.rst

Lines changed: 17 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -719,51 +719,36 @@ above.
719719
An example's doctest directives modify doctest's behavior for that single
720720
example. Use ``+`` to enable the named behavior, or ``-`` to disable it.
721721

722-
For example, this test passes:
722+
For example, this test passes::
723723

724-
.. doctest::
725-
:no-trim-doctest-flags:
726-
727-
>>> print(list(range(20))) # doctest: +NORMALIZE_WHITESPACE
724+
>>> print(list(range(20))) # doctest: +NORMALIZE_WHITESPACE
728725
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9,
729726
10, 11, 12, 13, 14, 15, 16, 17, 18, 19]
730727

731728
Without the directive it would fail, both because the actual output doesn't have
732729
two blanks before the single-digit list elements, and because the actual output
733730
is on a single line. This test also passes, and also requires a directive to do
734-
so:
735-
736-
.. doctest::
737-
:no-trim-doctest-flags:
731+
so::
738732

739-
>>> print(list(range(20))) # doctest: +ELLIPSIS
733+
>>> print(list(range(20))) # doctest: +ELLIPSIS
740734
[0, 1, ..., 18, 19]
741735

742736
Multiple directives can be used on a single physical line, separated by
743-
commas:
737+
commas::
744738

745-
.. doctest::
746-
:no-trim-doctest-flags:
747-
748-
>>> print(list(range(20))) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
739+
>>> print(list(range(20))) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
749740
[0, 1, ..., 18, 19]
750741

751742
If multiple directive comments are used for a single example, then they are
752-
combined:
753-
754-
.. doctest::
755-
:no-trim-doctest-flags:
743+
combined::
756744

757-
>>> print(list(range(20))) # doctest: +ELLIPSIS
758-
... # doctest: +NORMALIZE_WHITESPACE
745+
>>> print(list(range(20))) # doctest: +ELLIPSIS
746+
... # doctest: +NORMALIZE_WHITESPACE
759747
[0, 1, ..., 18, 19]
760748

761749
As the previous example shows, you can add ``...`` lines to your example
762750
containing only directives. This can be useful when an example is too long for
763-
a directive to comfortably fit on the same line:
764-
765-
.. doctest::
766-
:no-trim-doctest-flags:
751+
a directive to comfortably fit on the same line::
767752

768753
>>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40)))
769754
... # doctest: +ELLIPSIS
@@ -808,23 +793,18 @@ instead. Another is to do ::
808793

809794
There are others, but you get the idea.
810795

811-
Another bad idea is to print things that embed an object address, like
812-
813-
.. doctest::
796+
Another bad idea is to print things that embed an object address, like ::
814797

815-
>>> id(1.0) # certain to fail some of the time # doctest: +SKIP
798+
>>> id(1.0) # certain to fail some of the time
816799
7948648
817800
>>> class C: pass
818-
>>> C() # the default repr() for instances embeds an address # doctest: +SKIP
819-
<C object at 0x00AC18F0>
820-
821-
The :const:`ELLIPSIS` directive gives a nice approach for the last example:
801+
>>> C() # the default repr() for instances embeds an address
802+
<__main__.C instance at 0x00AC18F0>
822803

823-
.. doctest::
824-
:no-trim-doctest-flags:
804+
The :const:`ELLIPSIS` directive gives a nice approach for the last example::
825805

826-
>>> C() # doctest: +ELLIPSIS
827-
<C object at 0x...>
806+
>>> C() #doctest: +ELLIPSIS
807+
<__main__.C instance at 0x...>
828808

829809
Floating-point numbers are also subject to small output variations across
830810
platforms, because Python defers to the platform C library for float formatting,

0 commit comments

Comments
 (0)