Skip to content

Commit 2522490

Browse files
committed
test: some fixes in documentation
1 parent f0cce26 commit 2522490

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

doc/source/testing/testLauncher.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Overview
77

88
The class :doc:`idfxTest <idfxTest>` provides the basement to implement an *Idefix* integration test for validation.
99
In order to ease launching all the tests, the user might prefer to use directly the ``./test.py`` command at the
10-
root or *Idefix* sources.
10+
root of the *Idefix* sources.
1111

12-
This script will run all the registered variants of *Idefix* and build a report in the terminal. At the
12+
This script will run all the listed variants of *Idefix* and build a report in the terminal. At the
1313
end of the run a standard ``junit.xml`` file is produced. This one can be translated into a browsable
1414
HTML file.
1515

@@ -61,7 +61,7 @@ The result of the execution will be an output like :
6161
---------- generated xml file: idefix-tests.junit.xml ---------------------------------------------------------
6262
=============================== 8 passed, 44 deselected in 73.03s (0:01:13) ===================================
6363
64-
In case of an error, the output of the command will be printed.
64+
When seeing an error, the output of the command will be printed at the end.
6565

6666
HTML report
6767
-----------
@@ -117,7 +117,7 @@ Here the options supported by the test script :
117117
-fake Make a fake run by just logging the actions to validate that we generate same command over refactoring.
118118
-subdir SUBDIR Select the test in the given subdir not to run all.
119119
120-
The script is constructed on top of the ``pytest`` command so you automatically get access
120+
The script is built on top of the ``pytest`` command so you automatically get access
121121
to all the advanced option this command provide. Here a few examples :
122122

123123
.. code-block:: shell
@@ -159,7 +159,7 @@ For a single basic configuration one can use :
159159
Available parameters
160160
--------------------
161161

162-
The parameters in the ``variants`` dictionnary correspond to the option supported by the
162+
The parameters in the ``variants`` dictionnary correspond to the options supported by the
163163
:doc:`idfxTest <idfxTest>` script to configure the build and run of *Idefix*.
164164

165165
In addition there is some extra keys which are dedicated to the json interpretation layer :
@@ -197,7 +197,7 @@ Looping over parameters
197197

198198
You might want to explore running Idefix within parameter ranges (configuration files, modes).
199199
For this simply list the values you want as a list. The test script will automatically
200-
generate the list of all combinations.
200+
generate all combinations.
201201

202202
.. code-block:: json
203203
@@ -329,7 +329,7 @@ it simplified the writting of some conditions like if you used and IF statement.
329329
}
330330
}
331331
332-
In this case, ``reconstrucion`` will be set to 1 when ``single`` equal to ``true``.
332+
In this case, ``reconstruction`` will be set to 1 when ``single`` is equal to ``true``.
333333

334334
Note that the ``conditions`` field can contains several values which will be treaded
335335
as and AND logical operator.

0 commit comments

Comments
 (0)