Skip to content

Commit d88a197

Browse files
committed
doc: document aliases of tests stanza
Signed-off-by: Ali Caglayan <[email protected]>
1 parent 41616b8 commit d88a197

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

doc/reference/dune/test.rst

+7-5
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@ can define two tests at once with:
2626
(names mytest expect_test)
2727
<optional fields>)
2828
29-
This defines an executable named ``mytest.exe`` that will be executed as part of
30-
the ``runtest`` alias. If the directory also contains an
31-
``expect_test.expected`` file, then ``expect_test`` will be used to define an
32-
expect test. That is, the test will be executed and its output will be compared
33-
to ``expect_test.expected``.
29+
This defines an executable named ``mytest.exe``. These tests can be run by
30+
building the aliases ``mytest`` and ``expect_test`` respectively. They will also
31+
be added to the ``runtest`` alias.
32+
33+
If the directory also contains an ``expect_test.expected`` file, then
34+
``expect_test`` will be used to define an expect test. That is, the test will be
35+
executed and its output will be compared to ``expect_test.expected``.
3436

3537
The optional fields supported are a subset of the alias and executables fields.
3638
In particular, all fields except for ``public_names`` are supported from the

0 commit comments

Comments
 (0)