Skip to content

Commit 5db1ebc

Browse files
authored
Apply suggestions from code review
1 parent 43de476 commit 5db1ebc

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

doc/usage/extensions/doctest.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ a comma-separated list of group names.
5757
:type: text
5858
5959
Skip the directive if the python expression *condition* is True.
60-
See :ref:`skipif`.
60+
See :ref:`skipping tests conditionally <skipif>`.
6161
6262
6363
.. rst:directive:: .. testcleanup:: [group]
@@ -73,7 +73,7 @@ a comma-separated list of group names.
7373
:type: text
7474
7575
Skip the directive if the python expression *condition* is True.
76-
See :ref:`skipif`.
76+
See :ref:`skipping tests conditionally <skipif>`.
7777
7878
7979
.. rst:directive:: .. doctest:: [group]
@@ -87,8 +87,8 @@ a comma-separated list of group names.
8787

8888
.. rst:directive:option:: hide
8989
90-
Hide the doctest block in other builders. By default it is shown as a
91-
highlighted doctest block.
90+
Hide the doctest block in other builders.
91+
By default it is shown as a highlighted doctest block.
9292
9393
.. rst:directive:option:: options: doctest flags
9494
:type: comma separated list
@@ -97,7 +97,9 @@ a comma-separated list of group names.
9797
tests. (You still can give explicit flags per example, with doctest comments,
9898
but they will show up in other builders too.)
9999
100-
Alternatively, you can give inline doctest options, like in doctest::
100+
Alternatively, you can give inline doctest options, like in doctest:
101+
102+
.. code-block:: pycon
101103
102104
>>> datetime.date.now() # doctest: +SKIP
103105
datetime.date(2008, 1, 1)
@@ -149,7 +151,7 @@ a comma-separated list of group names.
149151
:type: text
150152
151153
Skip the directive if the python expression *condition* is True.
152-
See :ref:`skipif`.
154+
See :ref:`skipping tests conditionally <skipif>`.
153155
154156
.. rst:directive:: .. testcode:: [group]
155157
@@ -159,8 +161,8 @@ a comma-separated list of group names.
159161

160162
.. rst:directive:option:: hide
161163
162-
Hide the code block in other builders. By default it is shown as a
163-
highlighted code block.
164+
Hide the code block in other builders.
165+
By default it is shown as a highlighted code block.
164166
165167
.. rst:directive:option:: trim-doctest-flags
166168
no-trim-doctest-flags
@@ -173,7 +175,7 @@ a comma-separated list of group names.
173175
:type: text
174176
175177
Skip the directive if the python expression *condition* is True.
176-
See :ref:`skipif`.
178+
See :ref:`skipping tests conditionally <skipif>`.
177179
178180
.. note::
179181

@@ -202,8 +204,8 @@ a comma-separated list of group names.
202204

203205
.. rst:directive:option:: hide
204206
205-
Hide the doctest block in other builders. By default it is shown as a
206-
highlighted doctest block.
207+
Hide the doctest block in other builders.
208+
By default it is shown as a highlighted doctest block.
207209
208210
.. rst:directive:option:: options: doctest flags
209211
:type: comma separated list
@@ -221,7 +223,7 @@ a comma-separated list of group names.
221223
:type: text
222224
223225
Skip the directive if the python expression *condition* is True.
224-
See :ref:`skipif`.
226+
See :ref:`skipping tests conditionally <skipif>`.
225227
226228
Example::
227229

0 commit comments

Comments
 (0)